Support organization-level runner #97

kmdkuk · 2021-10-12T08:58:48Z

#74
Signed-off-by: kouki kouworld0123@gmail.com

Signed-off-by: kouki <kouworld0123@gmail.com>

constants.go

controllers/runnerpool_controller.go

docs/user-manual.md

Signed-off-by: kouki <kouworld0123@gmail.com>

This reverts commit aa63350.

masa213f · 2021-10-27T22:57:15Z

cmd/meows/cmd/slackagent/slackagent.go

+		Short: "set slack channel to notify.",
+		Long:  `This command TODO description`,


Suggested change

Short: "set slack channel to notify.",

Long: `This command TODO description`,

Short: "set slack channel to notify.",

Long: `set slack channel to notify.`,

masa213f · 2021-10-27T23:14:38Z

cmd/meows/cmd/slackagent/slackagent.go

+				channel = os.Getenv(constants.SlackChannelEnvName)
+			}
+
+			err = ioutil.WriteFile(slackChannelFilePath, []byte(channel), 0644)


Could you read These documents?
https://golang.org/doc/go1.16#ioutil
https://pkg.go.dev/io/ioutil#WriteFile

You can use os.WriteFile instead.

And {os/ioutil}.WriteFile will overwrite if target file exists.
So you need not remove the slack channel file before.

I did not know about this information. Thank you.
I'll fix it together with some other places that use ioutil.

masa213f · 2021-10-27T23:26:17Z

cmd/meows/cmd/slackagent/slackagent.go

+			if len(args) == 1 {
+				channel = args[0]
+			}
+			err := os.MkdirAll(constants.RunnerVarDirPath, 0755)


You should not create /var/meows here.
Since an emptyDir will be mounted in /var/meows, so usually the directory exists.

And if -file /path/to/otherDir/otherFile flag is set, the slack channel will be written in the other dir.

Suggested change

err := os.MkdirAll(constants.RunnerVarDirPath, 0755)

err := os.MkdirAll(constants.RunnerVarDirPath, 0755)

Signed-off-by: kouki <kouworld0123@gmail.com>

kmdkuk · 2021-10-28T05:30:27Z

When I commanded echo "#test1" > /var/meows/slack_channel, I forgot to push the updated documentation, so I added cf57f87.

masa213f · 2021-10-28T06:54:22Z

docs/commands.md

+This sub command set a Slack channel to notified job result.
+This is used by calling it in the workflow yaml file.
+If it is not specified, the environment variable `MEOWS_SLACK_CHANNEL` is specified.


Suggested change

This sub command set a Slack channel to notified job result.

This is used by calling it in the workflow yaml file.

If it is not specified, the environment variable `MEOWS_SLACK_CHANNEL` is specified.

This sub command sets a Slack channel that a job result will be notified to.

This command should be called in a workflow.

Users can specify the Slack channel as an argument.

If the argument is not specified, the environment variable `MEOWS_SLACK_CHANNEL` is read instead.

masa213f · 2021-10-28T08:47:32Z

docs/user-manual.md

+
+The following methods exist for specifying the channel for Slack notifications.
+The priority order of the specification method is 4>3>2>1.
+Any channel specification method should look like `#<channel_name>`. (e.g. `#general`, `#test1`)


Suggested change

Any channel specification method should look like `#<channel_name>`. (e.g. `#general`, `#test1`)

Any method accepts a channel name in the format of `#<channel_name>`. (e.g. `#general`, `#test1`)

masa213f · 2021-10-28T08:50:06Z

docs/user-manual.md

+1. Slack app secret to be created in [How to deploy Slack agent](#how-to-deploy-slack-agent)
+2. `RunnerPool` resource in `.spec.slackAgent.channel`. [docs to SlackAgentConfig](crd-runner-pool.md#SlackAgentConfig)
+3. Environment variables in the workflow.
+    - The `MEOWS_SLACK_CHANNEL` environment variable is read when `job-started` is executed.
+4. Call command `meows slackagent set-channel "#channel"` in the workflow step.
+    - You can specify the channel to be notified by using the command as follows.
+    ```yaml
+    name: slack-channel-specified
+    on: push
+
+    jobs:
+      build:
+        name: job-name
+        env:
+          MEOWS_SLACK_CHANNEL: "#test2"
+        steps:
+          - run: job-started
+          # The environment variable `MEOWS_SLACK_CHANNEL` is ignored and the job results are reported to the "#test1" channel.
+          - run: meows slackagent set-channel "#test1"
+          - run: job-success
+    ```


1. `SLACK_CHANNEL` value in the `slack-app-secret` secret. See [How to deploy Slack agent](#how-to-deploy-slack-agent). 2. `.spec.slackAgent.channel` field in a `RunnerPool` resource. See [SlackAgentConfig](crd-runner-pool.md#SlackAgentConfig). 3. `MEOWS_SLACK_CHANNEL` environment variable in a workflow. 4. Call `meows slackagent set-channel "#channel"` command in a workflow. For example, you can specify the channel in a workflow as follows. ```yaml name: slack-channel-specified on: push jobs: build: name: job-name env: # Basically, a job result will be reported to the "#test1" channel. MEOWS_SLACK_CHANNEL: "#test1" steps: - run: job-started # Only when a job fails, the result will be reported to the "#test2" channel. - run: meows slackagent set-channel "#test2" if: failure() - run: job-success ```

masa213f · 2021-10-28T08:56:35Z

cmd/meows/cmd/slackagent/slackagent.go

+		Long: `This command set a Slack channel to notified job result.
+This is used by calling it in the workflow yaml file.
+If SLACK_CHANNEL_NAME is not specified, the environment variable MEOWS_SLACK_CHANNEL is specified as a Slack channel to notified.`,


Suggested change

Long: `This command set a Slack channel to notified job result.

This is used by calling it in the workflow yaml file.

If SLACK_CHANNEL_NAME is not specified, the environment variable MEOWS_SLACK_CHANNEL is specified as a Slack channel to notified.`,

Long: `This command sets a Slack channel that a job result to be notified to.

This should be called in a workflow.

If SLACK_CHANNEL_NAME is not specified, the environment variable MEOWS_SLACK_CHANNEL is read.`,

masa213f · 2021-10-28T09:04:22Z

api/v1alpha1/runnerpool_types.go

@@ -25,6 +25,8 @@ var reservedEnvNames = map[string]bool{
 // RunnerPoolSpec defines the desired state of RunnerPool
 type RunnerPoolSpec struct {
 	// RepositoryName describes repository name to register Pods as self-hosted runners.
+	// RepositoryName is not necessary, If you want to use it as an organization-level self-hosted runner


Suggested change

// RepositoryName is not necessary, If you want to use it as an organization-level self-hosted runner

// If this field is omitted or the empty string (`""`) is specified, Pods will be registered as organization-level self-hosted runners.

Signed-off-by: kouki <kouworld0123@gmail.com>

masa213f

LGTM

kmdkuk self-assigned this Oct 12, 2021

kmdkuk changed the title ~~Change the minimum test to an organization-level RunnerPool.~~ WIP Support organization-level runner Oct 12, 2021

kmdkuk force-pushed the support-org-runner branch 7 times, most recently from 93a3ab1 to cb1f5bb Compare October 15, 2021 09:46

kmdkuk changed the title ~~WIP Support organization-level runner~~ Support organization-level runner Oct 19, 2021

kmdkuk force-pushed the support-org-runner branch from 29bd4c2 to b99d070 Compare October 19, 2021 07:12

kmdkuk added 2 commits October 19, 2021 07:13

Support organization-level runner

29ba96f

Signed-off-by: kouki <kouworld0123@gmail.com>

rename kindtest component

7f7ef10

Signed-off-by: kouki <kouworld0123@gmail.com>

kmdkuk force-pushed the support-org-runner branch 3 times, most recently from e368318 to cc4b31a Compare October 19, 2021 07:46

kmdkuk added 2 commits October 19, 2021 08:49

fix how to specify and prioritize channels in slack

2a9c635

Signed-off-by: kouki <kouworld0123@gmail.com>

update documentation

09dd58b

Signed-off-by: kouki <kouworld0123@gmail.com>

kmdkuk force-pushed the support-org-runner branch from cc4b31a to 09dd58b Compare October 19, 2021 08:50

kmdkuk marked this pull request as ready for review October 19, 2021 09:29

kmdkuk requested review from masa213f and zoetrope October 19, 2021 09:29

masa213f reviewed Oct 21, 2021

View reviewed changes

constants.go Outdated Show resolved Hide resolved

controllers/runnerpool_controller.go Outdated Show resolved Hide resolved

docs/user-manual.md Outdated Show resolved Hide resolved

docs/user-manual.md Show resolved Hide resolved

kmdkuk added 4 commits October 26, 2021 05:00

reflect suggested changes

836ebef

Signed-off-by: kouki <kouworld0123@gmail.com>

Add scripts/meows-slack-channel

aa63350

Signed-off-by: kouki <kouworld0123@gmail.com>

Add sub command

cd746d3

Signed-off-by: kouki <kouworld0123@gmail.com>

Revert "Add scripts/meows-slack-channel"

a83c334

This reverts commit aa63350.

kmdkuk requested a review from masa213f October 27, 2021 08:20

masa213f requested changes Oct 27, 2021

View reviewed changes

kmdkuk force-pushed the support-org-runner branch from 54536b3 to 0dc818b Compare October 28, 2021 01:04

kmdkuk added 2 commits October 28, 2021 04:23

Reflect comments.

4b7ed3f

Signed-off-by: kouki <kouworld0123@gmail.com>

update user-manual.md

cf57f87

Signed-off-by: kouki <kouworld0123@gmail.com>

kmdkuk force-pushed the support-org-runner branch from 58762cf to cf57f87 Compare October 28, 2021 04:24

masa213f requested changes Oct 28, 2021

View reviewed changes

reflect suggested changes

5625de1

Signed-off-by: kouki <kouworld0123@gmail.com>

kmdkuk force-pushed the support-org-runner branch from b790480 to 5625de1 Compare October 29, 2021 05:16

kmdkuk requested a review from masa213f October 29, 2021 06:09

masa213f approved these changes Nov 1, 2021

View reviewed changes

kmdkuk merged commit 24bfa2d into main Nov 1, 2021

kmdkuk deleted the support-org-runner branch November 1, 2021 01:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support organization-level runner #97

Support organization-level runner #97

kmdkuk commented Oct 12, 2021 •

edited

Loading

masa213f Oct 27, 2021

masa213f Oct 27, 2021

kmdkuk Oct 28, 2021

masa213f Oct 27, 2021

kmdkuk commented Oct 28, 2021

masa213f Oct 28, 2021

masa213f Oct 28, 2021

masa213f Oct 28, 2021

masa213f Oct 28, 2021

masa213f Oct 28, 2021

masa213f left a comment

		Short: "set slack channel to notify.",
		Long: `This command TODO description`,

	err := os.MkdirAll(constants.RunnerVarDirPath, 0755)
	err := os.MkdirAll(constants.RunnerVarDirPath, 0755)

-This sub command set a Slack channel to notified job result.
-This is used by calling it in the workflow yaml file.
-If it is not specified, the environment variable `MEOWS_SLACK_CHANNEL` is specified.
+This sub command sets a Slack channel that a job result will be notified to.
+This command should be called in a workflow.
+Users can specify the Slack channel as an argument.
+If the argument is not specified, the environment variable `MEOWS_SLACK_CHANNEL` is read instead.

	Any channel specification method should look like `#<channel_name>`. (e.g. `#general`, `#test1`)
	Any method accepts a channel name in the format of `#<channel_name>`. (e.g. `#general`, `#test1`)

	// RepositoryName is not necessary, If you want to use it as an organization-level self-hosted runner
	// If this field is omitted or the empty string (`""`) is specified, Pods will be registered as organization-level self-hosted runners.

Support organization-level runner #97

Support organization-level runner #97

Conversation

kmdkuk commented Oct 12, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kmdkuk commented Oct 28, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

masa213f left a comment

Choose a reason for hiding this comment

kmdkuk commented Oct 12, 2021 •

edited

Loading