🥇Hitelesítés a Kubernetesben a GitHub OAuth és Dex használatával

Egy oktatóanyagot mutatok be a Kubernetes-fürthöz való hozzáférés létrehozásához a Dex, a dex-k8s-authenticator és a GitHub használatával.

Helyi mém az orosz nyelvű Kubernetesből chat-be Telegram

Bevezetés

A Kubernetes segítségével dinamikus környezeteket hozunk létre a fejlesztési és minőségbiztosítási csapat számára. Tehát hozzáférést szeretnénk biztosítani számukra a fürthöz mind az irányítópult, mind a kubectl számára. Az OpenShifttel ellentétben a vanilla Kubernetes nem rendelkezik natív hitelesítéssel, ezért ehhez harmadik féltől származó eszközöket használunk.

Ebben a konfigurációban a következőket használjuk:

dex-k8s-hitelesítő — webalkalmazás a kubectl config generálására
Dex — OpenID Connect szolgáltató
GitHub – egyszerűen azért, mert cégünkben GitHubot használunk

Próbáltuk használni a Google OIDC-t, de sajnos sikerült sikertelen csoportokkal indítani őket, így a GitHubbal való integráció elég jól megfelelt nekünk. Csoportleképezés nélkül nem lehet csoportokon alapuló RBAC-házirendeket létrehozni.

Tehát hogyan működik a Kubernetes engedélyezési folyamatunk vizuális megjelenítésben:

Engedélyezési folyamat

Kicsit részletesebben és pontról pontra:

A felhasználó bejelentkezik a dex-k8s-authenticator (login.k8s.example.com)
A dex-k8s-authenticator továbbítja a kérést Dexnek (dex.k8s.example.com)
A Dex átirányítja a GitHub bejelentkezési oldalára
A GitHub előállítja a szükséges engedélyezési információkat, és visszaküldi a Dexnek
A Dex átadja a kapott információkat a dex-k8s-authenticatornak
A felhasználó OIDC tokent kap a GitHubtól
A dex-k8s-authenticator tokent ad hozzá a kubeconfighoz
A kubectl átadja a tokent a KubeAPIServernek
A KubeAPIServer az átadott token alapján ad vissza hozzáférést a kubectl-hez
A felhasználó a kubectl-től kap hozzáférést

Előkészítő intézkedések

Természetesen már telepítve van egy Kubernetes-fürt (k8s.example.com), és előtelepített HELM-mel is érkezik. Van egy szervezetünk is a GitHubon (super-org).
Ha nincs HELM, telepítse Nagyon egyszerű.

Először be kell állítanunk a GitHubot.

Lépjen a szervezeti beállítások oldalára, (https://github.com/organizations/super-org/settings/applications), és hozzon létre egy új alkalmazást (engedélyezett OAuth alkalmazás):

Új alkalmazás létrehozása a GitHubon

Töltse ki a mezőket a szükséges URL-ekkel, például:

Kezdőlap URL: https://dex.k8s.example.com
Engedélyezési visszahívási URL: https://dex.k8s.example.com/callback

Legyen óvatos a linkekkel, fontos, hogy ne veszítse el a perjeleket.

A kitöltött űrlapra válaszul a GitHub generál Client ID и Client secret, tartsa biztonságos helyen, hasznosak lesznek számunkra (például használjuk Boltozat titkok tárolására):

Client ID: 1ab2c3d4e5f6g7h8
Client secret: 98z76y54x32w1

Készítsen DNS-rekordokat az aldomainekhez login.k8s.example.com и dex.k8s.example.com, valamint SSL-tanúsítványok a belépéshez.

Hozzunk létre SSL-tanúsítványokat:

cat <<EOF | kubectl create -f -
apiVersion: certmanager.k8s.io/v1alpha1
kind: Certificate
metadata:
  name: cert-auth-dex
  namespace: kube-system
spec:
  secretName: cert-auth-dex
  dnsNames:
    - dex.k8s.example.com
  acme:
    config:
    - http01:
        ingressClass: nginx
      domains:
      - dex.k8s.example.com
  issuerRef:
    name: le-clusterissuer
    kind: ClusterIssuer
---
apiVersion: certmanager.k8s.io/v1alpha1
kind: Certificate
metadata:
  name: cert-auth-login
  namespace: kube-system
spec:
  secretName: cert-auth-login
  dnsNames:
    - login.k8s.example.com
  acme:
    config:
    - http01:
        ingressClass: nginx
      domains:
      - login.k8s.example.com
  issuerRef:
    name: le-clusterissuer
    kind: ClusterIssuer
EOF
kubectl describe certificates cert-auth-dex -n kube-system
kubectl describe certificates cert-auth-login -n kube-system

ClusterIssuer címmel le-clusterissuer már léteznie kell, de ha nem, hozza létre a HELM segítségével:

helm install --namespace kube-system -n cert-manager stable/cert-manager
cat << EOF | kubectl create -f -
apiVersion: certmanager.k8s.io/v1alpha1
kind: ClusterIssuer
metadata:
  name: le-clusterissuer
  namespace: kube-system
spec:
  acme:
    server: https://acme-v02.api.letsencrypt.org/directory
    email: [email protected]
    privateKeySecretRef:
      name: le-clusterissuer
    http01: {}
EOF

KubeAPIServer konfiguráció

A kubeAPIServer működéséhez konfigurálnia kell az OIDC-t és frissítenie kell a fürtöt:

kops edit cluster
...
  kubeAPIServer:
    anonymousAuth: false
    authorizationMode: RBAC
    oidcClientID: dex-k8s-authenticator
    oidcGroupsClaim: groups
    oidcIssuerURL: https://dex.k8s.example.com/
    oidcUsernameClaim: email
kops update cluster --yes
kops rolling-update cluster --yes

Használunk rúgás fürtök üzembe helyezéséhez, de ez hasonlóan működik más klasztermenedzserek.

Dex konfiguráció és dex-k8s-hitelesítő

Ahhoz, hogy a Dex működjön, rendelkeznie kell egy tanúsítvánnyal és egy kulccsal a Kubernetes mestertől, onnan szerezzük be:

sudo cat /srv/kubernetes/ca.{crt,key}
-----BEGIN CERTIFICATE-----
AAAAAAAAAAABBBBBBBBBBCCCCCC
-----END CERTIFICATE-----
-----BEGIN RSA PRIVATE KEY-----
DDDDDDDDDDDEEEEEEEEEEFFFFFF
-----END RSA PRIVATE KEY-----

Klónozzuk a dex-k8s-authenticator lerakat:

git clone [email protected]:mintel/dex-k8s-authenticator.git
cd dex-k8s-authenticator/

Az értékfájlok segítségével rugalmasan konfigurálhatjuk a változókat HELM diagramok.

Leírjuk a Dex konfigurációját:

cat << EOF > values-dex.yml
global:
  deployEnv: prod
tls:
  certificate: |-
    -----BEGIN CERTIFICATE-----
    AAAAAAAAAAABBBBBBBBBBCCCCCC
    -----END CERTIFICATE-----
  key: |-
    -----BEGIN RSA PRIVATE KEY-----
    DDDDDDDDDDDEEEEEEEEEEFFFFFF
    -----END RSA PRIVATE KEY-----
ingress:
  enabled: true
  annotations:
    kubernetes.io/ingress.class: nginx
    kubernetes.io/tls-acme: "true"
  path: /
  hosts:
    - dex.k8s.example.com
  tls:
    - secretName: cert-auth-dex
      hosts:
        - dex.k8s.example.com
serviceAccount:
  create: true
  name: dex-auth-sa
config: |
  issuer: https://dex.k8s.example.com/
  storage: # https://github.com/dexidp/dex/issues/798
    type: sqlite3
    config:
      file: /var/dex.db
  web:
    http: 0.0.0.0:5556
  frontend:
    theme: "coreos"
    issuer: "Example Co"
    issuerUrl: "https://example.com"
    logoUrl: https://example.com/images/logo-250x25.png
  expiry:
    signingKeys: "6h"
    idTokens: "24h"
  logger:
    level: debug
    format: json
  oauth2:
    responseTypes: ["code", "token", "id_token"]
    skipApprovalScreen: true
  connectors:
  - type: github
    id: github
    name: GitHub
    config:
      clientID: $GITHUB_CLIENT_ID
      clientSecret: $GITHUB_CLIENT_SECRET
      redirectURI: https://dex.k8s.example.com/callback
      orgs:
      - name: super-org
        teams:
        - team-red
  staticClients:
  - id: dex-k8s-authenticator
    name: dex-k8s-authenticator
    secret: generatedLongRandomPhrase
    redirectURIs:
      - https://login.k8s.example.com/callback/
envSecrets:
  GITHUB_CLIENT_ID: "1ab2c3d4e5f6g7h8"
  GITHUB_CLIENT_SECRET: "98z76y54x32w1"
EOF

És a dex-k8s-authenticator esetében:

cat << EOF > values-auth.yml
global:
  deployEnv: prod
dexK8sAuthenticator:
  clusters:
  - name: k8s.example.com
    short_description: "k8s cluster"
    description: "Kubernetes cluster"
    issuer: https://dex.k8s.example.com/
    k8s_master_uri: https://api.k8s.example.com
    client_id: dex-k8s-authenticator
    client_secret: generatedLongRandomPhrase
    redirect_uri: https://login.k8s.example.com/callback/
    k8s_ca_pem: |
      -----BEGIN CERTIFICATE-----
      AAAAAAAAAAABBBBBBBBBBCCCCCC
      -----END CERTIFICATE-----
ingress:
  enabled: true
  annotations:
    kubernetes.io/ingress.class: nginx
    kubernetes.io/tls-acme: "true"
  path: /
  hosts:
    - login.k8s.example.com
  tls:
    - secretName: cert-auth-login
      hosts:
        - login.k8s.example.com
EOF

A Dex és a dex-k8s-authenticator telepítése:

helm install -n dex --namespace kube-system --values values-dex.yml charts/dex
helm install -n dex-auth --namespace kube-system --values values-auth.yml charts/dex-k8s-authenticator

Ellenőrizzük a szolgáltatások működőképességét (a Dexnek a 400-as kódot, a dex-k8s-authenticatornak pedig a 200-as kódot kell visszaadnia):

curl -sI https://dex.k8s.example.com/callback | head -1
HTTP/2 400
curl -sI https://login.k8s.example.com/ | head -1
HTTP/2 200

RBAC konfiguráció

A csoporthoz létrehozunk egy ClusterRole-t, esetünkben csak olvasási hozzáféréssel:

cat << EOF | kubectl create -f -
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: cluster-read-all
rules:
  -
    apiGroups:
      - ""
      - apps
      - autoscaling
      - batch
      - extensions
      - policy
      - rbac.authorization.k8s.io
      - storage.k8s.io
    resources:
      - componentstatuses
      - configmaps
      - cronjobs
      - daemonsets
      - deployments
      - events
      - endpoints
      - horizontalpodautoscalers
      - ingress
      - ingresses
      - jobs
      - limitranges
      - namespaces
      - nodes
      - pods
      - pods/log
      - pods/exec
      - persistentvolumes
      - persistentvolumeclaims
      - resourcequotas
      - replicasets
      - replicationcontrollers
      - serviceaccounts
      - services
      - statefulsets
      - storageclasses
      - clusterroles
      - roles
    verbs:
      - get
      - watch
      - list
  - nonResourceURLs: ["*"]
    verbs:
      - get
      - watch
      - list
  - apiGroups: [""]
    resources: ["pods/exec"]
    verbs: ["create"]
EOF

Hozzuk létre a ClusterRoleBinding konfigurációját:

cat <<EOF | kubectl create -f -
apiVersion: rbac.authorization.k8s.io/v1beta1
kind: ClusterRoleBinding
metadata:
  name: dex-cluster-auth
  namespace: kube-system
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: cluster-read-all
subjects:
  kind: Group
  name: "super-org:team-red"
EOF

Most készen állunk a tesztelésre.

Tesztek

Menj a bejelentkezési oldalra (https://login.k8s.example.com), és jelentkezzen be GitHub-fiókjával:

Bejelentkezési oldal

A bejelentkezési oldal átirányítva a GitHubba

Kövesse a generált utasításokat a hozzáféréshez

A weboldal másolása és beillesztése után a kubectl segítségével kezelhetjük fürt erőforrásainkat:

kubectl get po
NAME                READY   STATUS    RESTARTS   AGE
mypod               1/1     Running   0          3d

kubectl delete po mypod
Error from server (Forbidden): pods "mypod" is forbidden: User "[email protected]" cannot delete pods in the namespace "default"

És működik, a szervezetünkben minden GitHub-felhasználó láthatja az erőforrásokat, és bejelentkezhet a pod-okba, de nincs joguk megváltoztatni azokat.

Forrás: will.com

Hitelesítés a Kubernetesben a GitHub OAuth és Dex használatával