implement ServiceAccountTokenProjection #62005
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
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
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
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
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
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,40 @@ | ||
| load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test") | ||
|
There was a problem hiding this comment. Do you want to add an OWNERS file too? |
||
|
|
||
| filegroup( | ||
| name = "package-srcs", | ||
| srcs = glob(["**"]), | ||
| tags = ["automanaged"], | ||
| visibility = ["//visibility:private"], | ||
| ) | ||
|
|
||
| filegroup( | ||
| name = "all-srcs", | ||
| srcs = [":package-srcs"], | ||
| tags = ["automanaged"], | ||
| visibility = ["//visibility:public"], | ||
| ) | ||
|
|
||
| go_library( | ||
| name = "go_default_library", | ||
| srcs = ["token_manager.go"], | ||
| importpath = "k8s.io/kubernetes/pkg/kubelet/token", | ||
| visibility = ["//visibility:public"], | ||
| deps = [ | ||
| "//vendor/github.com/golang/glog:go_default_library", | ||
| "//vendor/k8s.io/api/authentication/v1:go_default_library", | ||
| "//vendor/k8s.io/apimachinery/pkg/util/clock:go_default_library", | ||
| "//vendor/k8s.io/apimachinery/pkg/util/wait:go_default_library", | ||
| "//vendor/k8s.io/client-go/kubernetes/typed/core/v1:go_default_library", | ||
| ], | ||
| ) | ||
|
|
||
| go_test( | ||
| name = "go_default_test", | ||
| srcs = ["token_manager_test.go"], | ||
| embed = [":go_default_library"], | ||
| deps = [ | ||
| "//vendor/k8s.io/api/authentication/v1:go_default_library", | ||
| "//vendor/k8s.io/apimachinery/pkg/apis/meta/v1:go_default_library", | ||
| "//vendor/k8s.io/apimachinery/pkg/util/clock:go_default_library", | ||
| ], | ||
| ) | ||
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,6 @@ | ||
| approvers: | ||
| - mikedanese | ||
| reviewers: | ||
| - mikedanese | ||
| - awly | ||
| - tallclair |
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,147 @@ | ||
| /* | ||
| Copyright 2018 The Kubernetes Authors. | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| // Package token implements a manager of serviceaccount tokens for pods running | ||
| // on the node. | ||
| package token | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "sync" | ||
| "time" | ||
|
|
||
| "github.com/golang/glog" | ||
| authenticationv1 "k8s.io/api/authentication/v1" | ||
| "k8s.io/apimachinery/pkg/util/clock" | ||
| "k8s.io/apimachinery/pkg/util/wait" | ||
| corev1 "k8s.io/client-go/kubernetes/typed/core/v1" | ||
| ) | ||
|
|
||
| const ( | ||
| maxTTL = 24 * time.Hour | ||
| gcPeriod = time.Minute | ||
| ) | ||
|
|
||
| // NewManager returns a new token manager. | ||
| func NewManager(c corev1.CoreV1Interface) *Manager { | ||
| m := &Manager{ | ||
| getToken: func(name, namespace string, tr *authenticationv1.TokenRequest) (*authenticationv1.TokenRequest, error) { | ||
| return c.ServiceAccounts(namespace).CreateToken(name, tr) | ||
| }, | ||
| cache: make(map[string]*authenticationv1.TokenRequest), | ||
| clock: clock.RealClock{}, | ||
| } | ||
| go wait.Forever(m.cleanup, gcPeriod) | ||
| return m | ||
| } | ||
|
|
||
| // Manager manages service account tokens for pods. | ||
| type Manager struct { | ||
|
|
||
| // cacheMutex guards the cache | ||
| cacheMutex sync.RWMutex | ||
| cache map[string]*authenticationv1.TokenRequest | ||
|
|
||
| // mocked for testing | ||
| getToken func(name, namespace string, tr *authenticationv1.TokenRequest) (*authenticationv1.TokenRequest, error) | ||
| clock clock.Clock | ||
| } | ||
|
|
||
| // GetServiceAccountToken gets a service account token for a pod from cache or | ||
| // from the TokenRequest API. This process is as follows: | ||
| // * Check the cache for the current token request. | ||
| // * If the token exists and does not require a refresh, return the current token. | ||
| // * Attempt to refresh the token. | ||
| // * If the token is refreshed successfully, save it in the cache and return the token. | ||
| // * If refresh fails and the old token is still valid, log an error and return the old token. | ||
| // * If refresh fails and the old token is no longer valid, return an error | ||
| func (m *Manager) GetServiceAccountToken(name, namespace string, tr *authenticationv1.TokenRequest) (*authenticationv1.TokenRequest, error) { | ||
|
There was a problem hiding this comment. Is There was a problem hiding this comment. The name, namespace are of the service account. The actual TokenRequest has pod name and pod UID included in the object binding, which is validated on the apiserver. We can't include service account UID because that information is not present on the pod object. |
||
| key := keyFunc(name, namespace, tr) | ||
| ctr, ok := m.get(key) | ||
|
|
||
| if ok && !m.requiresRefresh(ctr) { | ||
| return ctr, nil | ||
| } | ||
|
|
||
| tr, err := m.getToken(name, namespace, tr) | ||
| if err != nil { | ||
| switch { | ||
| case !ok: | ||
| return nil, fmt.Errorf("failed to fetch token: %v", err) | ||
| case m.expired(ctr): | ||
| return nil, fmt.Errorf("token %s expired and refresh failed: %v", key, err) | ||
| default: | ||
| glog.Errorf("couldn't update token %s: %v", key, err) | ||
| return ctr, nil | ||
| } | ||
| } | ||
|
|
||
| m.set(key, tr) | ||
|
There was a problem hiding this comment. I think this is growing unbounded? It should grow slowly, but you need some way of clearing out old tokens. |
||
| return tr, nil | ||
| } | ||
|
|
||
| func (m *Manager) cleanup() { | ||
| m.cacheMutex.Lock() | ||
| defer m.cacheMutex.Unlock() | ||
| for k, tr := range m.cache { | ||
| if m.expired(tr) { | ||
| delete(m.cache, k) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func (m *Manager) get(key string) (*authenticationv1.TokenRequest, bool) { | ||
| m.cacheMutex.RLock() | ||
| defer m.cacheMutex.RUnlock() | ||
| ctr, ok := m.cache[key] | ||
| return ctr, ok | ||
| } | ||
|
|
||
| func (m *Manager) set(key string, tr *authenticationv1.TokenRequest) { | ||
| m.cacheMutex.Lock() | ||
| defer m.cacheMutex.Unlock() | ||
| m.cache[key] = tr | ||
| } | ||
|
|
||
| func (m *Manager) expired(t *authenticationv1.TokenRequest) bool { | ||
| return m.clock.Now().After(t.Status.ExpirationTimestamp.Time) | ||
| } | ||
|
|
||
| // requiresRefresh returns true if the token is older than 80% of its total | ||
| // ttl, or if the token is older than 24 hours. | ||
| func (m *Manager) requiresRefresh(tr *authenticationv1.TokenRequest) bool { | ||
| if tr.Spec.ExpirationSeconds == nil { | ||
| glog.Errorf("expiration seconds was nil for tr: %#v", tr) | ||
| return false | ||
| } | ||
| now := m.clock.Now() | ||
| exp := tr.Status.ExpirationTimestamp.Time | ||
| iat := exp.Add(-1 * time.Duration(*tr.Spec.ExpirationSeconds) * time.Second) | ||
|
|
||
| if now.After(iat.Add(maxTTL)) { | ||
| return true | ||
| } | ||
| // Require a refresh if within 20% of the TTL from the expiration time. | ||
| if now.After(exp.Add(-1 * time.Duration((*tr.Spec.ExpirationSeconds*20)/100) * time.Second)) { | ||
| return true | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| // keys should be nonconfidential and safe to log | ||
| func keyFunc(name, namespace string, tr *authenticationv1.TokenRequest) string { | ||
| return fmt.Sprintf("%q/%q/%#v", name, namespace, tr.Spec) | ||
|
There was a problem hiding this comment. Does this need to include expiration time? If it's encoded in the token, then I think the answer is yes. If it just controls the cache, then maybe not? There was a problem hiding this comment. It doesn't need an expiration time. The cache is essentially a map from TokenRequestSpec to TokenRequestStatus so an expiration timestamp is an attribute of the status. There was a problem hiding this comment. Er, sorry, I meant There was a problem hiding this comment. The ExpirationSeconds is in tr.Spec so the requested expiration is included in the cache key. Right now the requested expiration seconds will always be the expiration seconds, because we aren't implementing any sort of softmax. Two volume projections with the same spec should always project the same token. |
||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel like there should be some common RPC interface implementation where all methods are unimplemented and then you override the ones you need.