forked from flyteorg/flyte
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Bigquery] Add support for impersonation of GSA bound to task's KSA (f…
…lyteorg#355) * Support impersonation of GKE task workload identity bound GSA in BigQuery plugin Signed-off-by: Jeev B <[email protected]> * Fix linting Signed-off-by: Jeev B <[email protected]> --------- Signed-off-by: Jeev B <[email protected]>
- Loading branch information
Showing
5 changed files
with
196 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
111 changes: 111 additions & 0 deletions
111
...lugins/go/tasks/pluginmachinery/google/gke_task_workload_identity_token_source_factory.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| package google | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| pluginmachinery "github.com/flyteorg/flyteplugins/go/tasks/pluginmachinery/k8s" | ||
| "github.com/pkg/errors" | ||
| "golang.org/x/oauth2" | ||
| "google.golang.org/api/impersonate" | ||
| "google.golang.org/grpc/credentials/oauth" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/client-go/kubernetes" | ||
| "k8s.io/client-go/rest" | ||
| ) | ||
|
|
||
| const ( | ||
| gcpServiceAccountAnnotationKey = "iam.gke.io/gcp-service-account" | ||
| workflowIdentityDocURL = "https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity" | ||
| ) | ||
|
|
||
| var impersonationScopes = []string{"https://www.googleapis.com/auth/bigquery"} | ||
|
|
||
| type GkeTaskWorkloadIdentityTokenSourceFactoryConfig struct { | ||
| RemoteClusterConfig pluginmachinery.ClusterConfig `json:"remoteClusterConfig" pflag:"Configuration of remote GKE cluster"` | ||
| } | ||
|
|
||
| type gkeTaskWorkloadIdentityTokenSourceFactory struct { | ||
| kubeClient kubernetes.Interface | ||
| } | ||
|
|
||
| func (m *gkeTaskWorkloadIdentityTokenSourceFactory) getGcpServiceAccount( | ||
| ctx context.Context, | ||
| identity Identity, | ||
| ) (string, error) { | ||
| if identity.K8sServiceAccount == "" { | ||
| identity.K8sServiceAccount = "default" | ||
| } | ||
| serviceAccount, err := m.kubeClient.CoreV1().ServiceAccounts(identity.K8sNamespace).Get( | ||
| ctx, | ||
| identity.K8sServiceAccount, | ||
| metav1.GetOptions{}, | ||
| ) | ||
| if err != nil { | ||
| return "", errors.Wrapf(err, "failed to retrieve task k8s service account") | ||
| } | ||
|
|
||
| for key, value := range serviceAccount.Annotations { | ||
| if key == gcpServiceAccountAnnotationKey { | ||
| return value, nil | ||
| } | ||
| } | ||
|
|
||
| return "", errors.Errorf( | ||
| "[%v] annotation doesn't exist on k8s service account [%v/%v], read more at %v", | ||
| gcpServiceAccountAnnotationKey, | ||
| identity.K8sNamespace, | ||
| identity.K8sServiceAccount, | ||
| workflowIdentityDocURL) | ||
| } | ||
|
|
||
| func (m *gkeTaskWorkloadIdentityTokenSourceFactory) GetTokenSource( | ||
| ctx context.Context, | ||
| identity Identity, | ||
| ) (oauth2.TokenSource, error) { | ||
| gcpServiceAccount, err := m.getGcpServiceAccount(ctx, identity) | ||
| if err != nil { | ||
| return oauth.TokenSource{}, err | ||
| } | ||
|
|
||
| return impersonate.CredentialsTokenSource(ctx, impersonate.CredentialsConfig{ | ||
| TargetPrincipal: gcpServiceAccount, | ||
| Scopes: impersonationScopes, | ||
| }) | ||
| } | ||
|
|
||
| func getKubeClient( | ||
| config *GkeTaskWorkloadIdentityTokenSourceFactoryConfig, | ||
| ) (*kubernetes.Clientset, error) { | ||
| var kubeCfg *rest.Config | ||
| var err error | ||
| if config.RemoteClusterConfig.Enabled { | ||
| kubeCfg, err = pluginmachinery.KubeClientConfig( | ||
| config.RemoteClusterConfig.Endpoint, | ||
| config.RemoteClusterConfig.Auth, | ||
| ) | ||
| if err != nil { | ||
| return nil, errors.Wrapf(err, "Error building kubeconfig") | ||
| } | ||
| } else { | ||
| kubeCfg, err = rest.InClusterConfig() | ||
| if err != nil { | ||
| return nil, errors.Wrapf(err, "Cannot get InCluster kubeconfig") | ||
| } | ||
| } | ||
|
|
||
| kubeClient, err := kubernetes.NewForConfig(kubeCfg) | ||
| if err != nil { | ||
| return nil, errors.Wrapf(err, "Error building kubernetes clientset") | ||
| } | ||
| return kubeClient, err | ||
| } | ||
|
|
||
| func NewGkeTaskWorkloadIdentityTokenSourceFactory( | ||
| config *GkeTaskWorkloadIdentityTokenSourceFactoryConfig, | ||
| ) (TokenSourceFactory, error) { | ||
| kubeClient, err := getKubeClient(config) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return &gkeTaskWorkloadIdentityTokenSourceFactory{kubeClient: kubeClient}, nil | ||
| } |
64 changes: 64 additions & 0 deletions
64
...s/go/tasks/pluginmachinery/google/gke_task_workload_identity_token_source_factory_test.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| package google | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| corev1 "k8s.io/api/core/v1" | ||
| v1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/client-go/kubernetes/fake" | ||
| ) | ||
|
|
||
| func TestGetGcpServiceAccount(t *testing.T) { | ||
| ctx := context.TODO() | ||
|
|
||
| t.Run("get GCP service account", func(t *testing.T) { | ||
| kubeClient := fake.NewSimpleClientset(&corev1.ServiceAccount{ | ||
| ObjectMeta: v1.ObjectMeta{ | ||
| Name: "name", | ||
| Namespace: "namespace", | ||
| Annotations: map[string]string{ | ||
| "owner": "abc", | ||
| "iam.gke.io/gcp-service-account": "gcp-service-account", | ||
| }, | ||
| }}) | ||
| ts := gkeTaskWorkloadIdentityTokenSourceFactory{kubeClient: kubeClient} | ||
| gcpServiceAccount, err := ts.getGcpServiceAccount(ctx, Identity{ | ||
| K8sNamespace: "namespace", | ||
| K8sServiceAccount: "name", | ||
| }) | ||
|
|
||
| assert.NoError(t, err) | ||
| assert.Equal(t, "gcp-service-account", gcpServiceAccount) | ||
| }) | ||
|
|
||
| t.Run("no GCP service account", func(t *testing.T) { | ||
| kubeClient := fake.NewSimpleClientset() | ||
| ts := gkeTaskWorkloadIdentityTokenSourceFactory{kubeClient: kubeClient} | ||
| _, err := ts.getGcpServiceAccount(ctx, Identity{ | ||
| K8sNamespace: "namespace", | ||
| K8sServiceAccount: "name", | ||
| }) | ||
|
|
||
| assert.ErrorContains(t, err, "failed to retrieve task k8s service account") | ||
| }) | ||
|
|
||
| t.Run("no GCP service account annotation", func(t *testing.T) { | ||
| kubeClient := fake.NewSimpleClientset(&corev1.ServiceAccount{ | ||
| ObjectMeta: v1.ObjectMeta{ | ||
| Name: "name", | ||
| Namespace: "namespace", | ||
| Annotations: map[string]string{ | ||
| "owner": "abc", | ||
| }, | ||
| }}) | ||
| ts := gkeTaskWorkloadIdentityTokenSourceFactory{kubeClient: kubeClient} | ||
| _, err := ts.getGcpServiceAccount(ctx, Identity{ | ||
| K8sNamespace: "namespace", | ||
| K8sServiceAccount: "name", | ||
| }) | ||
|
|
||
| assert.ErrorContains(t, err, "annotation doesn't exist on k8s service account") | ||
| }) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters