{"id":952,"date":"2024-02-12T05:06:10","date_gmt":"2024-02-12T05:06:10","guid":{"rendered":"https:\/\/blog.ngocha.biz\/?p=952"},"modified":"2024-02-12T05:06:10","modified_gmt":"2024-02-12T05:06:10","slug":"github-actions-runner-aws-eks","status":"publish","type":"post","link":"https:\/\/blog.ngocha.biz\/?p=952","title":{"rendered":"How to Setup GitHub Actions Runner on AWS EKS Cluster (Self Hosted)"},"content":{"rendered":"

In this guide, I am going to show you how to set up a Github Actions self-hosted runner on the AWS EKS Cluster.<\/p>\n

Prerequisites<\/h2>\n
    \n
  1. GitHub repository with access to create Personal Access Token (PAT)<\/li>\n
  2. EKS Cluster<\/li>\n
  3. Helm Installed in your system<\/li>\n<\/ol>\n

    Configuring Runner on AWS EKS Cluster<\/h2>\n

    Follow the below steps to set up a self-hosted runner on EKS.<\/p>\n

    Step 1: Install Cert Manager on EKS Cluster<\/h3>\n

    Run the below commands to install cert-manager on the EKS cluster using helm.<\/p>\n

    kubectl apply -f https:\/\/github.com\/cert-manager\/cert-manager\/releases\/download\/v1.13.2\/cert-manager.yaml<\/code><\/pre>\n
    This command will install cert-manager on the cert-manager namespace<\/code><\/strong> as default.<\/p>\n
    You can check if cert-manager is installed properly using the command below<\/p>\n
    kubectl get pods --namespace cert-manager<\/code><\/pre>\n
    \"\"<\/figure>\n
    Step 2: Create Authentication Token<\/h3>\n
    To authenticate the EKS cluster as a runner to GitHub Actions we are going to use the Personal Access Token (PAT) of GitHub.<\/p>\n
    To create the token go to Settings->Developer settings->Personal access tokens<\/code><\/strong>, then select tokens and press the generate new token button as shown in the below image<\/p>\n
    \"\"<\/figure>\n
    Select Generate New token and a new page will open, give a name for your token and select the repo<\/code><\/strong> access as shown in the below image.<\/p>\n
    \"\"<\/figure>\n
    Now, generate the token by pressing the Generate token button at the bottom.<\/p>\n
    Copy the access token and create a Kubernetes secret using the below command, the secret containing the access token will be used by the actions runner controller.<\/p>\n
    Create a namespace and secret for actions-runner-controller using the command given below<\/p>\n
    kubectl create ns actions-runner-system\n\nkubectl create secret generic controller-manager -n actions-runner-system --from-literal=github_token=xxxxxxxxxxxxxxxxxx43rw<\/code><\/pre>\n
    Make sure to specify your access token in the above command.<\/p>\n
    Step 3: Install Actions Runner Controller (ARC) on EKS Cluster<\/h3>\n
    Actions Runner Controller is an operator of Kubernetes that manages the self-hosted runners of GitHub actions.<\/p>\n
    It makes sure that the required resources to run a workflow in available by automatically deploying, scaling, and monitoring the runners on the cluster according to the needs.<\/p>\n
    To install Actions Runner Controller on your EKS cluster run the following commands<\/p>\n
    helm repo add actions-runner-controller https:\/\/actions-runner-controller.github.io\/actions-runner-controller\n\nhelm repo update\n\nhelm upgrade --install --namespace actions-runner-system \\\n  --create-namespace --wait actions-runner-controller \\\n  actions-runner-controller\/actions-runner-controller \\\n  --set syncPeriod=1m<\/code><\/pre>\n
    Once the installation is done, run the command given below to verify if the action runner controller is installed properly.<\/p>\n
    kubectl get all -n actions-runner-system<\/code><\/pre>\n
    You will get the following output<\/p>\n
    \"\"<\/figure>\n
    Step 4: Deploy Runner<\/h3>\n
    To deploy a self-hosted runner for GitHub Actions, create a YML file runner.yml and copy the below content<\/p>\n
    apiVersion: actions.summerwind.dev\/v1alpha1\nkind: RunnerDeployment\nmetadata:\n  name: k8s-action-runner\n  namespace: actions-runner-system\nspec:\n  replicas: 1\n  template:\n    spec:\n      repository: pet-clinic-project\/github-actions\n      labels:\n        - \"eks_runner\"<\/code><\/pre>\n
    Make sure to replace the repository name and label of your runner.<\/p>\n
    Run the below command to deploy the runner<\/p>\n
    kubectl create -f runner.yml<\/code><\/pre>\n
    Check if the pod for the runner is created and running using the command<\/p>\n
    kubectl get pod -n actions-runner-system | grep -i \"k8s-action-runner\"<\/code><\/pre>\n
    You will get the following output while running the above command<\/p>\n
    \"\"<\/figure>\n
    Now you can see your runner has been registered on GitHub in Settings -> Actions -> Runners<\/strong> as shown below<\/p>\n
    \"\"<\/figure>\n
    Test GitHub Actions Workflow<\/h2>\n
    I am going to run the workflow with simple steps to check if the self-hosted runner is working properly. Create a YML file and your repository structure should be like given below<\/p>\n
    .\n\u251c\u2500\u2500 README.md\n\u2514\u2500\u2500 .github\n    \u2514\u2500\u2500 workflows\n        \u2514\u2500\u2500 test.yml<\/code><\/pre>\n
    In GitHub Actions a YML file will be used to run the workflow which will be placed under the .github\/workflows directory as shown in the above structure. Copy the below contents and paste them into your YML file.<\/p>\n
    name: Testing\n\non:\n  push:\n    branches:\n      - main\n\njobs:\n  build:\n    runs-on: eks_runner\n    container:\n      image: ubuntu:latest\n    steps:\n    - name: Checkout Repository\n      uses: actions\/checkout@v2\n      with:\n        ref: main\n\n    - name: Echo Message\n      run: echo \"Hello World\"<\/code><\/pre>\n
    This YML file is configured like the workflow gets triggered whenever a change is pushed to the main branch and runs the build job on your GitHub Actions self-hosted runner.<\/p>\n
    Make sure to specify your runner’s name in the above YML file.<\/p>\n
    After creating the YML file, push the changes to your repository that will trigger the workflow.<\/p>\n
    You can see if the build process has started by going to your GitHub repository and selecting the Actions tab as given below.<\/p>\n
    \"\"<\/figure>\n
    Once your job has been finished, you can view the summary of the workflow as shown below.<\/p>\n
    \"\"<\/figure>\n
    \n
    Ngu\u1ed3n:<\/strong> How to Setup GitHub Actions Runner on AWS EKS Cluster (Self Hosted) \u2014 DevOpsCube<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
    Source: https:\/\/devopscube.com\/github-actions-runner-aws-eks\/<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-952","post","type-post","status-publish","format-standard","hentry","category-devops"],"_links":{"self":[{"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/posts\/952","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=952"}],"version-history":[{"count":0,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/posts\/952\/revisions"}],"wp:attachment":[{"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=952"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=952"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=952"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}