consensys/kubernetes-action

GitHub Action to run kubectl

kubernetes-action

Interacts with kubernetes clusters calling kubectl commands. Integrates support for AWS EKS.

Usage

Basic Example

name: CI

on:
  - push

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2

      - name: Trigger deploy
        uses: Consensys/kubernetes-action@master
        env:
          KUBE_CONFIG_DATA: ${{ secrets.KUBE_CONFIG_DATA }}
        with:
          args: apply deployment.yaml

EKS Example

name: CI

on:
  - push

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2

      - name: Configure AWS Credentials
        uses: aws-actions/configure-aws-credentials@v1
        with:
          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
          aws-region: us-east-1

      - name: Trigger deploy
        uses: Consensys/kubernetes-action@master
        env:
          KUBE_CONFIG_DATA: ${{ secrets.KUBE_CONFIG_DATA }}
        with:
          args: apply deployment.yaml

Config

Secrets

One or more secrets needs to be created to store cluster credentials. (see here for help on creating secrets).

Basic

• KUBE_CONFIG_DATA: A base64 representation of ~/.kube/config file.

Example

cat ~/.kube/config | base64 | pbcopy # pbcopy will copy the secret to the clipboard (Mac OSX only)

EKS

• KUBE_CONFIG_DATA: Same as Basic configuration above.

• AWS_ACCESS_KEY_ID: AWS_ACCESS_KEY_ID of a IAM user with permissions to access the cluster.

• AWS_SECRET_ACCESS_KEY: AWS_SECRET_ACCESS_KEY of a IAM user with permissions to access the cluster.

Make sure your users has the proper IAM permissions to access your cluster and that its configured inside kubernetes (more info here).

Outputs

• result: Output of the kubectl command.

Example

      - name: Save container image
        id: image-save
        uses: Consensys/kubernetes-action@master
        env:
          KUBE_CONFIG_DATA: ${{ secrets.KUBE_CONFIG_DATA }}
        with:
          args: get deploy foo -o jsonpath="{..image}"

      - name: Print image
        run: 
          echo ${{ steps.image-save.outputs.result }}

More info on how to use outputs here.

kubernetes-action's Issues

Action fails because incompatible python version for awscli

Currently I'm seeing this action fail with an error (see logs below).

I believe problem comes from this recent change in awscli package that removes support for python 2.7.

Wondering if/when issue will be corrected here. This is blocking my deployments so I need a fix asap.

Step 4/8 : RUN pip install awscli
   ---> Running in 516ceb5c09b9
  Collecting awscli
    Downloading https://files.pythonhosted.org/packages/aa/24/e098cf5ce28a764bca174e88f4ccb70754e9f049c9bf986e582aedcb7420/awscli-1.19.112-py2.py3-none-any.whl (3.6MB)
  Collecting botocore==1.20.112 (from awscli)
    Downloading https://files.pythonhosted.org/packages/c7/ea/11c3beca131920f552602b98d7ba9fc5b46bee6a59cbd48a95a85cbb8f41/botocore-1.20.112-py2.py3-none-any.whl (7.7MB)
  Collecting s3transfer<0.5.0,>=0.4.0 (from awscli)
    Downloading https://files.pythonhosted.org/packages/63/d0/693477c688348654ddc21dcdce0817653a294aa[43](https://github.com/tryhungry/hungry-services/actions/runs/5578112763/jobs/10191862056#step:3:43)f41771084c25e7ff9c7/s3transfer-0.4.2-py2.py3-none-any.whl (79kB)
  Collecting colorama<0.4.4,>=0.2.5 (from awscli)
    Downloading https://files.pythonhosted.org/packages/c9/dc/[45](https://github.com/tryhungry/hungry-services/actions/runs/5578112763/jobs/10191862056#step:3:45)cdef1b4d119eb96316b3117e6d5708a08029992b2fee2c143c7a0a5cc5/colorama-0.4.3-py2.py3-none-any.whl
  Collecting PyYAML<5.5,>=3.10 (from awscli)
    Downloading https://files.pythonhosted.org/packages/a0/a4/d63f2d7597e1a4b55aa3b4d6c5b029991d3b824b5bd331af8d4ab1ed687d/PyYAML-5.4.1.tar.gz (175kB)
    Installing build dependencies: started
    Installing build dependencies: finished with status 'done'
      Complete output from command python setup.py egg_info:
      running egg_info
      creating pip-egg-info/PyYAML.egg-info
      writing pip-egg-info/PyYAML.egg-info/PKG-INFO
      writing top-level names to pip-egg-info/PyYAML.egg-info/top_level.txt
      writing dependency_links to pip-egg-info/PyYAML.egg-info/dependency_links.txt
      writing manifest file 'pip-egg-info/PyYAML.egg-info/SOURCES.txt'
      Traceback (most recent call last):
        File "<string>", line 1, in <module>
        File "/tmp/pip-install-n212Qs/PyYAML/setup.py", line 295, in <module>
          python_requires='>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*',
        File "/tmp/pip-build-env-_dpnrk/lib/python2.7/site-packages/setuptools/__init__.py", line 162, in setup
          return distutils.core.setup(**attrs)
        File "/usr/lib/python2.7/distutils/core.py", line 1[51](https://github.com/tryhungry/hungry-services/actions/runs/5578112763/jobs/10191862056#step:3:51), in setup
          dist.run_commands()
        File "/usr/lib/python2.7/distutils/dist.py", line 9[53](https://github.com/tryhungry/hungry-services/actions/runs/5578112763/jobs/10191862056#step:3:53), in run_commands
          self.run_command(cmd)
        File "/usr/lib/python2.7/distutils/dist.py", line 972, in run_command
          cmd_obj.run()
        File "/tmp/pip-build-env-_dpnrk/lib/python2.7/site-packages/setuptools/command/egg_info.py", line 296, in run
          self.find_sources()
        File "/tmp/pip-build-env-_dpnrk/lib/python2.7/site-packages/setuptools/command/egg_info.py", line 303, in find_sources
          mm.run()
        File "/tmp/pip-build-env-_dpnrk/lib/python2.7/site-packages/setuptools/command/egg_info.py", line 534, in run
          self.add_defaults()
        File "/tmp/pip-build-env-_dpnrk/lib/python2.7/site-packages/setuptools/command/egg_info.py", line [57](https://github.com/tryhungry/hungry-services/actions/runs/5578112763/jobs/10191862056#step:3:57)0, in add_defaults
          sdist.add_defaults(self)
        File "/tmp/pip-build-env-_dpnrk/lib/python2.7/site-packages/setuptools/command/py36compat.py", line 36, in add_defaults
          self._add_defaults_ext()
        File "/tmp/pip-build-env-_dpnrk/lib/python2.7/site-packages/setuptools/command/py36compat.py", line 120, in _add_defaults_ext
          self.filelist.extend(build_ext.get_source_files())
        File "/tmp/pip-install-n212Qs/PyYAML/setup.py", line 201, in get_source_files
          self.cython_sources(ext.sources, ext)
        File "/usr/lib/python2.7/distutils/cmd.py", line 105, in __getattr__
          raise AttributeError, attr
      AttributeError: cython_sources

"aws-iam-authenticator": executable file not found in $PATH

Having an issue come up when using this acton:

unable to recognize "kubernetes/apps.yaml": Get https://****.***.****.eks.amazonaws.com/api?timeout=32s: getting credentials: exec: exec: "aws-iam-authenticator": executable file not found in $PATH

My actions file:

name: Build & Deploy to Kubernetes Cluster

# Manually execute this job now for testing purposes
on: [workflow_dispatch]

jobs:
  setup-build-publish-deploy:
    name: Setup, Build, Publish & Deploy
    runs-on: ubuntu-latest

    steps:

    - name: Checkout Resembletron
      uses: actions/checkout@v2

    - name: Configure AWS credentials
      uses: aws-actions/configure-aws-credentials@v1
      with:
        aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
        aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
        aws-region: us-east-1

    - name: Login to Amazon ECR
      id: login-ecr
      uses: aws-actions/amazon-ecr-login@v1

    - name: Build, tag,push image to Amazon ECR, and update deployment file
      env:
        ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
        ECR_REPOSITORY: resembletron-web
        IMAGE_TAG: ${{ github.sha }}
      run: |
        docker build -f docker/Dockerfile.web -t $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG .
        docker push $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG
        sed -i '/'$ECR_REGISTRY'\/'$ECR_REPOSITORY'/c\        image: '$ECR_REGISTRY'\/'$ECR_REPOSITORY':'$IMAGE_TAG'' kubernetes/apps.yaml

    - name: Deploy To Resemble Kubernetes Cluster
      uses: Consensys/kubernetes-action@master
      env:
        KUBE_CONFIG_DATA: ${{ secrets.KUBE_CONFIG_DATA }}
      with:
        args: apply -f kubernetes/apps.yaml

    - name: Logout of Amazon ECR
      if: always()
      run: docker logout ${{ steps.login-ecr.outputs.registry }}

Docker build failed

Hello,

First of all, thanks for this action!

Just wanted to let you know that it seems having an issue with building the image for this action.

This is the step where the error occurs based on our build logs

  Step 4/8 : RUN pip install awscli
  
   ---> Running in b3840c14c6d2
  Collecting awscli
    Downloading https://files.pythonhosted.org/packages/69/60/b865ce91eb8965746cc673bc35eac63fe51aed41a757401e1c8bbb6534c9/awscli-1.19.52-py2.py3-none-any.whl (3.6MB)
  Collecting colorama<0.4.4,>=0.2.5 (from awscli)
    Downloading https://files.pythonhosted.org/packages/c9/dc/45cdef1b4d119eb96316b3117e6d5708a08029992b2fee2c143c7a0a5cc5/colorama-0.4.3-py2.py3-none-any.whl
  Collecting PyYAML<5.5,>=3.10 (from awscli)
    Downloading https://files.pythonhosted.org/packages/a0/a4/d63f2d7597e1a4b55aa3b4d6c5b029991d3b824b5bd331af8d4ab1ed687d/PyYAML-5.4.1.tar.gz (175kB)
    Installing build dependencies: started
    Installing build dependencies: finished with status 'error'
    Complete output from command /usr/bin/python2 -m pip install --ignore-installed --no-user --prefix /tmp/pip-build-env-sDunpv --no-warn-script-location --no-binary :none: --only-binary :none: -i https://pypi.org/simple -- setuptools wheel Cython:
    Collecting setuptools
      Downloading https://files.pythonhosted.org/packages/e1/b7/182161210a13158cd3ccc41ee19aadef54496b74f2817cc147006ec932b4/setuptools-44.1.1-py2.py3-none-any.whl (583kB)
    Collecting wheel
      Downloading https://files.pythonhosted.org/packages/65/63/39d04c74222770ed1589c0eaba06c05891801219272420b40311cd60c880/wheel-0.36.2-py2.py3-none-any.whl
    Collecting Cython
      Downloading https://files.pythonhosted.org/packages/d9/cd/0d2d90b27219c07f68f1c25bcc7b02dd27639d2180add9d4b73e70945869/Cython-0.29.23.tar.gz (2.1MB)
    Installing collected packages: setuptools, wheel, Cython
      Running setup.py install for Cython: started
        Running setup.py install for Cython: finished with status 'error'
        Complete output from command /usr/bin/python2 -u -c "import setuptools, tokenize;__file__='/tmp/pip-install-4gCMSU/Cython/setup.py';f=getattr(tokenize, 'open', open)(__file__);code=f.read().replace('\r\n', '\n');f.close();exec(compile(code, __file__, 'exec'))" install --record /tmp/pip-record-bOm1O8/install-record.txt --single-version-externally-managed --prefix /tmp/pip-build-env-sDunpv --compile:
        Unable to find pgen, not compiling formal grammar.
        running install
        running build
        running build_py
        creating build
        creating build/lib.linux-x86_64-2.7
        copying cython.py -> build/lib.linux-x86_64-2.7
        creating build/lib.linux-x86_64-2.7/Cython
        copying Cython/Debugging.py -> build/lib.linux-x86_64-2.7/Cython
        copying Cython/TestUtils.py -> build/lib.linux-x86_64-2.7/Cython
        copying Cython/Utils.py -> build/lib.linux-x86_64-2.7/Cython
        copying Cython/Coverage.py -> build/lib.linux-x86_64-2.7/Cython
        copying Cython/Shadow.py -> build/lib.linux-x86_64-2.7/Cython
        copying Cython/CodeWriter.py -> build/lib.linux-x86_64-2.7/Cython
        copying Cython/__init__.py -> build/lib.linux-x86_64-2.7/Cython
        copying Cython/StringIOTree.py -> build/lib.linux-x86_64-2.7/Cython
        creating build/lib.linux-x86_64-2.7/Cython/Build
        copying Cython/Build/Dependencies.py -> build/lib.linux-x86_64-2.7/Cython/Build
        copying Cython/Build/Cythonize.py -> build/lib.linux-x86_64-2.7/Cython/Build
        copying Cython/Build/Inline.py -> build/lib.linux-x86_64-2.7/Cython/Build
        copying Cython/Build/BuildExecutable.py -> build/lib.linux-x86_64-2.7/Cython/Build
        copying Cython/Build/IpythonMagic.py -> build/lib.linux-x86_64-2.7/Cython/Build
        copying Cython/Build/Distutils.py -> build/lib.linux-x86_64-2.7/Cython/Build
        copying Cython/Build/__init__.py -> build/lib.linux-x86_64-2.7/Cython/Build
        creating build/lib.linux-x86_64-2.7/Cython/Compiler
        copying Cython/Compiler/Version.py -> build/lib.linux-x86_64-2.7/Cython/Compiler
        copying Cython/Compiler/TypeInference.py -> build/lib.linux-x86_64-2.7/Cython/Compiler
        copying Cython/Compiler/Buffer.py -> build/lib.linux-x86_64-2.7/Cython/Compiler
        copying Cython/Compiler/TreePath.py -> build/lib.linux-x86_64-2.7/Cython/Compiler
        copying Cython/Compiler/Symtab.py -> build/lib.linux-x86_64-2.7/Cython/Compiler
        copying Cython/Compiler/Future.py -> build/lib.linux-x86_64-2.7/Cython/Compiler
        copying Cython/Compiler/TreeFragment.py -> build/lib.linux-x86_64-2.7/Cython/Compiler
        copying Cython/Compiler/FlowControl.py -> build/lib.linux-x86_64-2.7/Cython/Compiler
        copying Cython/Compiler/PyrexTypes.py -> build/lib.linux-x86_64-2.7/Cython/Compiler
        copying Cython/Compiler/FusedNode.py -> build/lib.linux-x86_64-2.7/Cython/Compiler
        copying Cython/Compiler/Builtin.py -> build/lib.linux-x86_64-2.7/Cython/Compiler
        copying Cython/Compiler/Interpreter.py -> build/lib.linux-x86_64-2.7/Cython/Compiler
        copying Cython/Compiler/Annotate.py -> build/lib.linux-x86_64-2.7/Cython/Compiler
        copying Cython/Compiler/Nodes.py -> build/lib.linux-x86_64-2.7/Cython/Compiler
        copying Cython/Compiler/CythonScope.py -> build/lib.linux-x86_64-2.7/Cython/Compiler
        copying Cython/Compiler/AutoDocTransforms.py -> build/lib.linux-x86_64-2.7/Cython/Compiler
        copying Cython/Compiler/CodeGeneration.py -> build/lib.linux-x86_64-2.7/Cython/Compiler
        copying Cython/Compiler/Visitor.py -> build/lib.linux-x86_64-2.7/Cython/Compiler
        copying Cython/Compiler/MemoryView.py -> build/lib.linux-x86_64-2.7/Cython/Compiler
        copying Cython/Compiler/AnalysedTreeTransforms.py -> build/lib.linux-x86_64-2.7/Cython/Compiler
        copying Cython/Utility/CpdefEnums.pyx -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/MemoryView.pyx -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/TestCyUtilityLoader.pyx -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/TestCythonScope.pyx -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/Builtins.c -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/ExtensionTypes.c -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/ImportExport.c -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/TypeConversion.c -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/Profile.c -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/FunctionArguments.c -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/MemoryView_C.c -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/Buffer.c -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/AsyncGen.c -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/CythonFunction.c -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/ModuleSetupCode.c -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/Overflow.c -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/StringTools.c -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/Printing.c -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/Capsule.c -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/Optimize.c -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/CMath.c -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/Coroutine.c -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/Embed.c -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/CommonStructures.c -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/Exceptions.c -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/Complex.c -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/ObjectHandling.c -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/TestUtilityLoader.c -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/arrayarray.h -> build/lib.linux-x86_64-2.7/Cython/Utility
        copying Cython/Utility/CppSupport.cpp -> build/lib.linux-x86_64-2.7/Cython/Utility
        running build_ext
        building 'Cython.Plex.Scanners' extension
        creating build/temp.linux-x86_64-2.7
        creating build/temp.linux-x86_64-2.7/tmp
        creating build/temp.linux-x86_64-2.7/tmp/pip-install-4gCMSU
        creating build/temp.linux-x86_64-2.7/tmp/pip-install-4gCMSU/Cython
        creating build/temp.linux-x86_64-2.7/tmp/pip-install-4gCMSU/Cython/Cython
        creating build/temp.linux-x86_64-2.7/tmp/pip-install-4gCMSU/Cython/Cython/Plex
        gcc -fno-strict-aliasing -Os -fomit-frame-pointer -g -DNDEBUG -Os -fomit-frame-pointer -g -DTHREAD_STACK_SIZE=0x100000 -fPIC -I/usr/include/python2.7 -c /tmp/pip-install-4gCMSU/Cython/Cython/Plex/Scanners.c -o build/temp.linux-x86_64-2.7/tmp/pip-install-4gCMSU/Cython/Cython/Plex/Scanners.o
        unable to execute 'gcc': No such file or directory
        error: command 'gcc' failed with exit status 1
    
        ----------------------------------------
    Command "/usr/bin/python2 -u -c "import setuptools, tokenize;__file__='/tmp/pip-install-4gCMSU/Cython/setup.py';f=getattr(tokenize, 'open', open)(__file__);code=f.read().replace('\r\n', '\n');f.close();exec(compile(code, __file__, 'exec'))" install --record /tmp/pip-record-bOm1O8/install-record.txt --single-version-externally-managed --prefix /tmp/pip-build-env-sDunpv --compile" failed with error code 1 in /tmp/pip-install-4gCMSU/Cython/
    
    ----------------------------------------
  Command "/usr/bin/python2 -m pip install --ignore-installed --no-user --prefix /tmp/pip-build-env-sDunpv --no-warn-script-location --no-binary :none: --only-binary :none: -i https://pypi.org/simple -- setuptools wheel Cython" failed with error code 1 in None
  The command '/bin/sh -c pip install awscli' returned a non-zero code: 1

Let me know if we could do something on our end to help fix this.

Thanks and Best Regards!
Mikko

Unable to connect to the server

Unable to connect to the server: error executing access token command "/google/google-cloud-sdk/bin/gcloud config config-helper --format=json": err=fork/exec /google/google-cloud-sdk/bin/gcloud: no such file or directory output= stderr=

Any idea what is causing this error?

Thank you

Outdated K8 credential API version

Getting the following error when attempting to interact with AWS EKS:

Unable to connect to the server: getting credentials: exec plugin is configured to use API version client.authentication.k8s.io/v1beta1, plugin returned version client.authentication.k8s.io/v1alpha1

Unable to deploy

Hello,

Please can you help me understand what I am missing. I created an IAM user, added the user to the aws-auth in cluster, created a sample Kubeconfig and uploaded it along with the AWS secrets. Pushed the Code and it keeps failing. The deploy.yml file is in the same repo as the action.

Trigger deploy - Failed

Run Consensys/kubernetes-action@master
/usr/bin/docker run --name d35293bc4d0b6840949aa33b9d2237c3ac_4c5cad --label 3888d3 --workdir /github/workspace --rm -e AWS_DEFAULT_REGION -e AWS_REGION -e AWS_ACCESS_KEY_ID -e AWS_SECRET_ACCESS_KEY -e KUBE_CONFIG_DATA -e INPUT_ARGS -e HOME -e GITHUB_JOB -e GITHUB_REF -e GITHUB_SHA -e GITHUB_REPOSITORY -e GITHUB_REPOSITORY_OWNER -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_ACTOR -e GITHUB_WORKFLOW -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GITHUB_EVENT_NAME -e GITHUB_SERVER_URL -e GITHUB_API_URL -e GITHUB_GRAPHQL_URL -e GITHUB_WORKSPACE -e GITHUB_ACTION -e GITHUB_EVENT_PATH -e RUNNER_OS -e RUNNER_TOOL_CACHE -e RUNNER_TEMP -e RUNNER_WORKSPACE -e ACTIONS_RUNTIME_URL -e ACTIONS_RUNTIME_TOKEN -e ACTIONS_CACHE_URL -e GITHUB_ACTIONS=true -e CI=true -v "/var/run/docker.sock":"/var/run/docker.sock" -v "/home/runner/work/_temp/_github_home":"/github/home" -v "/home/runner/work/_temp/_github_workflow":"/github/workflow" -v "/home/runner/work/simpleapp/simpleapp":"/github/workspace" 3888d3:5293bc4d0b6840949aa33b9d2237c3ac "apply -f deploy.yml"
error: unable to recognize "deploy.yml": Get http://localhost:8080/api?timeout=32s: dial tcp 127.0.0.1:8080: connect: connection refused