Read our Blog: https://goteleport.com/blog/

Read our Documentation: https://goteleport.com/docs/getting-started/

auth-k8s uses Teleport Machine ID to generate an authorized Kubernetes client configuration for a specified cluster protected by Teleport.

The action sets the KUBECONFIG environment variable for consecutive steps in the job, meaning that tools like kubectl will automatically connect to the requested Kubernetes cluster without additional configuration.

Pre-requisites:

• Teleport 14 or above must be used. Use teleport-actions/auth-k8s@v1 for compatability with older versions of Teleport.
• Teleport binaries must already be installed in the job environment.
• The Kubernetes cluster you wish to access must already be connected to your Teleport cluster. See https://goteleport.com/docs/kubernetes-access/getting-started/
• You must have created a bot with a role with access to your Kubernetes cluster and created a GitHub join token that allows that bot to join.
• A Linux based runner.

Example usage:

on:
  workflow_dispatch: {}
jobs:
  demo-auth-k8s:
    runs-on: ubuntu-latest
    permissions:
      id-token: write
    steps:
      - name: Install Kubectl
        uses: azure/setup-kubectl@v3
      - name: Install Teleport
        uses: teleport-actions/setup@v1
        with:
          version: 14.0.0
      - name: Authorize against Teleport
        uses: teleport-actions/auth-k8s@v2
        with:
          # Specify the publically accessible address of your Teleport proxy.
          proxy: tele.example.com:443
          # Specify the name of the join token for your bot.
          token: my-github-join-token-name
          # Specify the length of time that the generated credentials should be
          # valid for. This is optional and defaults to "1h"
          certificate-ttl: 1h
          # Specify the name of the Kubernetes cluster you wish to access.
          kubernetes-cluster: my-kubernetes-cluster
          # Enable submission of anonymous usage telemetry to Teleport.
          # See https://goteleport.com/docs/machine-id/reference/telemetry/ for
          # more information.
          anonymous-telemetry: 1
      - name: List pods
        run: kubectl get pods

By default, this action will set the following environment variables:

• KUBECONFIG: the path to the generated Kubernetes configuration file.

This will automatically configure tools like kubectl to use the generated credentials. However, this can cause issues if you intend to invoke tbot multiple times.

You can disable this behaviour by setting the disable-env-vars input to true.

This action will output the following values:

• identity-file: the path to the identity file.
• kubeconfig: the path to the generated Kubernetes configuration file.

Read the teleport-actions/auth-k8s getting started guide: https://goteleport.com/docs/machine-id/guides/github-actions-kubernetes/