이 페이지에서는 OpenID 제공업체를 사용하여 GKE On-Prem 사용자 클러스터의 인증을 구성하는 방법을 보여줍니다. ADFS에서 OIDC를 사용하는 방법은 OIDC 및 ADFS로 인증을 참조하세요.
GKE On-Prem 인증 흐름의 개요는 인증을 참조하세요.
개요
GKE On-Prem은 OpenID Connect(OIDC)를 사용자 클러스터의 Kubernetes API 서버와 상호작용하는 인증 메커니즘 중 하나로 지원합니다. 클러스터 사용자의 인증 흐름을 자동으로 만들기 위해 GKE On-Prem은 kubectl 플러그인인 OIDC용 Kubectl 플러그인을 제공합니다.
이 실습에서는 OpenID 제공업체와 kubectl
의 관계를 구성합니다.
시작하기 전에
이 주제에서는 개발자가 OAuth 2.0 및 OpenID Connect에 익숙하다고 가정합니다. 이 주제에서는 개발자가 OpenID 범위 및 클레임에 익숙하다고 가정합니다.
ID 공급업체 선택
- ADFS(Active Directory Federated Services)를 OpenID 제공업체로 사용하고 AD의 온프레미스 인스턴스를 직원 데이터베이스로 사용합니다. OIDC 및 ADFS로 인증을 참조하세요.
- 다른 OpenID 제공업체를 사용합니다.
어떤 옵션을 선택하든 이 안내에 설명된 OIDC용 Kubectl 플러그인을 사용하여 인증 및 인증 프로세스 자체를 신속하게 구성할 수 있습니다. 이 주제에서는 ADFS 이외의 OpenID 제공업체를 사용하는 방법을 설명합니다.
OIDC용 Kubectl 플러그인 다운로드
플러그인을 다운로드하고 액세스 권한을 설정합니다.
Linux
gsutil cp gs://gke-on-prem-release/oidc-plugin/v1.1alpha/linux_amd64/kubectl-oidc . chmod +x kubectl-oidc
Windows
gsutil cp gs://gke-on-prem-release/oidc-plugin/v1.1alpha/windows_amd64/kubectl-oidc .
macOS
gsutil cp gs://gke-on-prem-release/oidc-plugin/v1.1alpha/darwin_amd64/kubectl-oidc . chmod +x kubectl-oidc
플러그인 설치
실행 파일을 원하는 PATH
위치로 이동시켜 플러그인을 설치합니다. 실행 파일의 이름은 kubectl-oidc
여야 합니다. 자세한 내용은 kubectl 플러그인 설치를 참조하세요.
리디렉션 URI 만들기
OpenID 제공업체와 관계를 설정하는 일환으로 제공업체가 ID 토큰을 반환하는 데 사용할 수 있는 리디렉션 URI를 지정해야 합니다. 토큰은 각 직원의 로컬 머신에서 실행되며 선택한 포트를 리슨하는 OIDC용 Kubectl 플러그인으로 이동합니다. 이 용도에 적합한 1024보다 큰 포트 번호를 선택합니다. 그러면 리디렉션 URI는 다음과 같습니다.
http://localhost:[PORT]/callback
여기서 [PORT]는 포트 번호입니다.
OpenID 제공업체에 OIDC용 Kubectl 플러그인 등록
OpenID 제공업체에서 OIDC용 Kubectl 플러그인을 사용하려면 먼저 제공업체에 플러그인을 등록해야 합니다. 등록 절차는 다음과 같습니다.
제공업체의 발급기관 URI를 알아봅니다. 여기에서 플러그인이 인증 요청을 보냅니다.
제공업체에게 리디렉션 URI를 제공합니다.
클라이언트 ID를 설정합니다. 이 ID는 제공업체가 플러그인을 식별하는 데 사용하는 ID입니다.
클라이언트 보안 비밀번호를 설정합니다. 플러그인은 이 보안 비밀을 사용하여 OpenID 제공업체를 인증합니다.
플러그인이 사용자의 보안 그룹을 요청하는 데 사용할 수 있는 커스텀 범위를 설정합니다.
제공업체가 사용자의 보안 그룹을 반환하는 데 사용할 커스텀 클레임 이름을 설정합니다.
이 단계를 수행하는 방법은 OpenID 제공업체에 따라 다릅니다. ADFS로 등록 단계를 수행하는 방법을 알아보려면 OIDC 및 ADFS로 인증을 참조하세요.
GKE On-Prem 구성 파일에서 oidc
사양 채우기
설치 중에 gkectl create-config
를 사용하여 GKE On-Prem 구성 파일을 생성합니다. 구성에는 다음 oidc
사양이 포함됩니다. `oidc`에 제공업체 특정 값을 채웁니다.
oidc: issuerurl: kubectlredirecturl: clientid: clientsecret: username: usernameprefix: group: groupprefix: scopes: extraparams: usehttpproxy: capath:
issuerurl
: OpenID 제공업체의 URL입니다(예:https://example.com/adfs
). OIDC용 Kubectl 플러그인과 같은 클라이언트 애플리케이션은 이 URL로 승인 요청을 보냅니다. Kubernetes API 서버는 이 URL을 사용하여 토큰 확인용 공개 키를 검색합니다. HTTPS를 사용해야 합니다. 필수 필드입니다.kubectlredirecturl
: OIDC용 Kubectl 플러그인의 localhost 리디렉션 URL입니다. 이 클러스터에 할당된 클라이언트 ID에서 사용할 OpenID 제공업체로 리디렉션 URL을 등록해야 합니다. 필수 필드입니다.clientid
: OpenID 제공업체에 인증을 요청하는 OIDC용 Kubectl 플러그인과 같은 클라이언트 애플리케이션의 ID입니다. 필수 필드입니다.clientsecret
: 클라이언트 애플리케이션의 보안 비밀입니다. 필수 필드입니다.usehttpproxy
: 클러스터에 역방향 프록시를 배포하여 Connect 에이전트가 사용자 인증을 위해 온프레미스 OIDC 제공업체에 액세스하도록 허용할지 여부를 선택합니다. 값은"true"
또는"false"
문자열이어야 합니다. 필수 필드입니다.username
: 사용자 이름으로 사용할 JWT 클레임입니다. 기본값은sub
이며 최종 사용자의 고유 식별자로 사용됩니다. OIDC 제공업체에 따라email
또는name
와 같은 다른 클레임을 선택할 수 있습니다. 하지만email
이외의 클레임에는 다른 플러그인과 이름 충돌을 방지하기 위해 발급기관 URL이 프리픽스로 추가됩니다.usernameprefix
: 기존 이름과 충돌을 방지하기 위해 사용자 이름 클레임에 추가되는 프리픽스입니다. 이 플래그가 제공되지 않고username
이 이메일 이외의 값이면 프리픽스 기본값은issueruri#
입니다.-
값을 사용하여 모든 프리픽스를 중지할 수 있습니다.group
: 사용자 그룹으로 사용할 JWT 클레임입니다. 클레임이 있는 경우 문자열 배열이어야 합니다.groupprefix
: 기존 이름과 충돌을 방지하기 위해 그룹 클레임에 추가된 프리픽스입니다. 예를 들어 그룹이foobar
이고 프리픽스가gid-
이면gid-foobar
가 됩니다.scopes
: 주석으로 구분된 목록으로 OpenID 제공업체에 보낼 추가 범위입니다.extraparams
: OpenID 제공업체에 전송할 추가 키-값 매개변수입니다.capath
: ID 공급업체의 웹 인증서에 서명한 인증 기관(CA)의 인증서 경로입니다.GKE On-Prem 클러스터는 TLS를 사용하여 구성요소 간의 통신을 보호합니다. Kubernetes가 설치 및 노드 부트스트랩 중에 자동으로 클라이언트 인증서를 생성하려면 GKE On-Prem을 CA와 함께 설치해야 합니다.
기본적으로 GKE On-Prem은 설치 중에 TLS 인증서를 생성하는 새 CA를 만듭니다. CA 및 생성된 인증서는 관리자 클러스터 내에 로컬로 저장됩니다.
예시: 그룹 인증 및 승인
대부분의 제공업체는 이메일 및 사용자 ID와 같은 사용자 식별 속성을 토큰에 인코딩합니다. 그러나 다음 속성은 인증 정책에 암시적 위험이 있습니다.
- 사용자 ID는 정책을 읽고 감사하기 어렵게 만들 수 있습니다.
- 이메일로 인해 가용성 위험(사용자가 기본 이메일을 변경하는 경우) 및 잠재적 보안 위험(이메일을 다시 할당할 수 있는 경우)이 생길 수 있습니다.
따라서 GID는 지속적이며 감사하기 쉬우므로 그룹 정책을 사용하는 것이 좋습니다.
제공업체가 다음 필드가 포함된 OpenID 토큰을 만든다고 가정해 보겠습니다.
{ 'iss': 'https://server.example.com' 'sub': 'u98523-4509823' 'groupList: ['developers@example.corp', 'us-east1-cluster-admins@example.corp'] ... }이 토큰 형식을 사용하면 다음과 같이 구성 파일의
oidc
사양을 채웁니다.issueruri: 'https://server.example.com' username: 'sub' usernameprefix: 'uid-' group: 'groupList' groupprefix: 'gid-' ...
사용자 클러스터를 만든 후 Kubernetes 역할 기반 액세스 제어(RBAC)를 사용하여 인증된 사용자에게 액세스 권한을 부여할 수 있습니다. 예를 들어 사용자에게 클러스터 보안 비밀에 대한 읽기 전용 액세스 권한을 부여하는 ClusterRole을 만들고 ClusterRoleBinding 리소스를 만들어 인증된 그룹에 역할을 결합할 수 있습니다.
ClusterRole
apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRole metadata: name: secret-reader rules: - apiGroups: [""] # The resource type for which access is granted resources: ["secrets"] # The permissions granted by the ClusterRole verbs: ["get", "watch", "list"]
ClusterRoleBinding
apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRoleBinding metadata: name: read-secrets-admins subjects: # Allows anyone in the "us-east1-cluster-admins" group to # read Secrets in any namespace within this cluster. - kind: Group name: gid-us-east1-cluster-admins # Name is case sensitive apiGroup: rbac.authorization.k8s.io # Allows this specific user to read Secrets in any # namespace within this cluster - kind: User name: uid-u98523-4509823 apiGroup: rbac.authorization.k8s.io roleRef: kind: ClusterRole name: secret-reader apiGroup: rbac.authorization.k8s.io
서버 인증 기관(CA) 인증서 만들기
사용자 클러스터의 kubeconfig는 호스트의 CA 데이터를 certificate-authority-data
필드에 저장합니다. 이 값을 디코딩하여 server-ca-cert
와 같은 로컬 파일에 저장해야 합니다.
cat [USER_CLUSTER_KUBECONFIG] | grep certificate-authority-data | awk '{ print $2}' | base64 --decode > server-ca-cert
클라이언트 인증 구성 파일 생성
OpenID의 사용자 클러스터를 구성하고 만든 후 kubectl oidc login
에 클라이언트 인증 구성 파일을 전달하면 사용자는 클러스터에 로그인할 수 있습니다. 이 명령어를 입력하여 클라이언트 인증 구성 파일을 생성합니다.
Linux
kubectl oidc client-config --issuer-uri [ISSUER_URI] \ --redirect-uri [REDIRECT_URI] \ --client-id [CLIENT_ID] \ --client-secret [CLIENT_SECRET] \ --scopes "[CUSTOM_SCOPES]" \ --cluster-name [USER_CLUSTER_NAME] \ --server [CLUSTER_URL] \ --server-ca-file server-ca-cert \ --issuer-ca-file [CA_CERT] \ --extra-params [KEY]=[VALUE] > client-config.yaml
- [ISSUER_URI]는 발급기관 URI입니다.
- [REDIRECT_URI]는 리디렉션 URI입니다.
- [CLIENT_ID]는 `kubectl` 애플리케이션의 클라이언트 ID입니다.
- [CLIENT_SECRET]은 자동으로 생성된 클라이언트 보안 비밀번호입니다.
- [USER_CLUSTER_NAME]은 사용자 클러스터의 이름입니다.
- [CLUSTER_URL]은 사용자 클러스터의 Kubernetes API 서버 URL입니다.
--server-ca-file
은 이전 섹션에서 만든 CA 파일의 경로를 허용합니다.- [CA_CERT]는 발급기관의 공개 CA 파일 경로입니다.
- [CUSTOM_SCOPES]는 보안 그룹을 위한 커스텀 범위의 쉼표로 구분된 목록입니다.
--extra-param
은 인증 요청과 함께 키-값 쌍을 OIDC 제공업체에 전송합니다.
PowerShell
kubectl oidc client-config --issuer-uri [ISSUER_URI] ` --redirect-uri [REDIRECT_URI] ` --client-id [CLIENT_ID] ` --client-secret [CLIENT_SECRET] ` --scopes "[CUSTOM_SCOPES]" ` --cluster-name [USER_CLUSTER_NAME] ` --server [CLUSTER_URL] ` --server-ca-file server-ca-cert ` --issuer-ca-file [CA_CERT] ` --extra-params [KEY]=[VALUE] > client-config.yaml
- [ISSUER_URI]는 발급기관 URI입니다.
- [REDIRECT_URI]는 리디렉션 URI입니다.
- [CLIENT_ID]는 `kubectl` 애플리케이션의 클라이언트 ID입니다.
- [CLIENT_SECRET]은 자동으로 생성된 클라이언트 보안 비밀번호입니다.
- [USER_CLUSTER_NAME]은 사용자 클러스터의 이름입니다.
- [CLUSTER_URL]은 사용자 클러스터의 Kubernetes API 서버 URL입니다.
--server-ca-file
은 이전 섹션에서 만든 CA 파일의 경로를 허용합니다.- [CA_CERT]는 발급기관의 공개 CA 파일 경로입니다.
- [CUSTOM_SCOPES]는 보안 그룹을 위한 커스텀 범위의 쉼표로 구분된 목록입니다.
--extra-param
은 인증 요청과 함께 키-값 쌍을 OIDC 제공업체에 전송합니다.
이 명령어는 client-config.yaml
이라는 클라이언트 인증 파일을 생성합니다.
이 파일을 수동으로 수정하지 마세요. 사용자 클러스터에 대해 인증해야 하는 각 직원에게 client-config.yaml
을 제공해야 합니다.
TLS 인증서 정보
GKE On-Prem 사용자 클러스터는 TLS를 사용하여 클러스터 구성요소 간의 모든 통신을 보호합니다. Kubernetes가 설치 및 노드 부트스트랩 중에 자동으로 클라이언트 인증서를 생성하려면 GKE On-Prem을 CA와 함께 설치해야 합니다.
기본적으로 GKE On-Prem은 설치 중에 TLS 인증서를 생성하는 새 CA를 만듭니다. CA 및 생성된 인증서는 관리자 클러스터 내에 로컬로 저장됩니다.
OIDC용 Kubectl 플러그인을 사용하여 사용자 클러스터에 인증
클라이언트 인증 파일을 사용하여 사용자 클러스터를 인증하려면 로컬 머신 또는 VM에서 다음 단계를 수행합니다.
client-config.yaml
파일을 사용하여 플러그인을 초기화합니다.kubectl oidc login --clientconfig-file=client-config.yaml --user [NAME] \ --kubeconfig [KUBECONFIG_OUTPUT_PATH]
각 매개변수는 다음과 같습니다.
- [NAME]은 선택한 사용자 이름입니다.
- [KUBECONFIG_OUTPUT_PATH]는 사용자 인증 정보가 저장된 kubeconfig 파일의 출력 위치입니다.
kubectl oidc login
은 사용자 또는 직원이 사용자 인증 정보를 입력할 수 있는 브라우저를 시작합니다.이제 kubeconfig 파일에 kubectl이 사용자 클러스터의 Kubernetes API 서버에 인증하는 데 사용할 수 있는 ID 토큰이 포함됩니다.
이제 인증되어야 합니다. 성공적으로 인증되었는지 확인하려면
kubectl
명령어를 입력합니다. 예:kubectl get nodes --kubeconfig [KUBECONFIG_OUTPUT_PATH]