actions / actions/actions-runner-controller

Github webhook server implementation does not match documentation

Open
#1,393 12 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Go
Stars
6.5k
Forks
1.5k
Avg merge
2d 2h
Merged PRs (30d)
27

Description

Describe the bug
I followed current instructions to implement the Github webhook server:

helm upgrade --install --namespace actions-runner-system --create-namespace
--wait actions-runner-controller actions-runner-controller/actions-runner-controller
--set "githubWebhookServer.enabled=true,githubWebhookServer.ports[0].nodePort=33080"

However, when I look at the service details, the webhook server is defined as a ClusterIP service with no reference to the nodePort defined in the helm chart installation

Checks

  • My actions-runner-controller version (v0.22.3) does support the feature
  • I'm using an unreleased version of the controller I built from HEAD of the default branch

To Reproduce
Steps to reproduce the behavior:

  1. Run webhook server installation per documented instructions:
    helm upgrade --install --namespace actions-runner-system --create-namespace
    --wait actions-runner-controller actions-runner-controller/actions-runner-controller
    --set "githubWebhookServer.enabled=true,githubWebhookServer.ports[0].nodePort=33080"
  2. Describe service:
    kubectl describe service actions-runner-controller-github-webhook-server

Expected behavior
Webhook server configuration should match that as described in documentation. I would expect it to be defined as a NodePort service. Please update documentation to match that of the underlying implementation.

Screenshots
$ kubectl describe service actions-runner-controller-github-webhook-server
Name: actions-runner-controller-github-webhook-server
Namespace:
Labels: app.kubernetes.io/instance=actions-runner-controller
app.kubernetes.io/managed-by=Helm
app.kubernetes.io/name=actions-runner-controller
app.kubernetes.io/version=0.22.3
helm.sh/chart=actions-runner-controller-0.17.3
Annotations: meta.helm.sh/release-name: actions-runner-controller
meta.helm.sh/release-namespace:
Selector: app.kubernetes.io/instance=actions-runner-controller-github-webhook-server,app.kubernetes.io/name=actions-runner-controller
Type: ClusterIP
IP Families:
IP: x.x.x.x
IPs:
Port: http 80/TCP
TargetPort: http/TCP
Endpoints: y.y.y.y:8000
Session Affinity: None
Events:

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the documented Helm command with the rendered actions-runner-controller-github-webhook-server service shown by kubectl describe service. Inspect the githubWebhookServer service configuration in the Helm chart and the related documentation to determine whether the chart or instructions are inconsistent. Done means the documentation and deployed service behavior agree, verified with the reproduction command.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, helm, kubernetes
Domain
devops, infrastructure
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.