-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add helper to generate sa token secret
Signed-off-by: Tamal Saha <tamal@appscode.com>
- Loading branch information
Showing
2 changed files
with
230 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,110 @@ | ||
/* | ||
Copyright AppsCode Inc. and Contributors | ||
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 client | ||
|
||
import ( | ||
"context" | ||
"time" | ||
|
||
core_util "kmodules.xyz/client-go/core/v1" | ||
meta_util "kmodules.xyz/client-go/meta" | ||
|
||
"github.com/pkg/errors" | ||
core "k8s.io/api/core/v1" | ||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
utilrand "k8s.io/apimachinery/pkg/util/rand" | ||
"k8s.io/apimachinery/pkg/util/wait" | ||
"k8s.io/klog/v2" | ||
kutil "kmodules.xyz/client-go" | ||
"sigs.k8s.io/controller-runtime/pkg/client" | ||
) | ||
|
||
// https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/#token-controller | ||
func getServiceAccountTokenSecret(kc client.Client, sa client.ObjectKey) (*core.Secret, error) { | ||
var list core.SecretList | ||
err := kc.List(context.TODO(), &list, client.InNamespace(sa.Namespace)) | ||
if err != nil { | ||
return nil, err | ||
} | ||
if len(list.Items) == 0 { | ||
return nil, errors.New("token secret still haven't created yet") | ||
} | ||
for _, s := range list.Items { | ||
if s.Type == core.SecretTypeServiceAccountToken && | ||
s.Annotations[core.ServiceAccountNameKey] == sa.Name { | ||
return &s, nil | ||
} | ||
} | ||
return nil, errors.New("token secret still haven't created yet") | ||
} | ||
|
||
const ( | ||
RetryTimeout = 10 * time.Second | ||
) | ||
|
||
func tryGetServiceAccountTokenSecret(kc client.Client, sa client.ObjectKey) (secret *core.Secret, err error) { | ||
err = wait.PollImmediate(kutil.RetryInterval, RetryTimeout, func() (bool, error) { | ||
var e2 error | ||
secret, e2 = getServiceAccountTokenSecret(kc, sa) | ||
if e2 == nil { | ||
return true, nil | ||
} | ||
klog.V(5).Infof("trying to get token secret for service account %s", sa) | ||
return false, nil | ||
}) | ||
return | ||
} | ||
|
||
func GetServiceAccountTokenSecret(kc client.Client, sa client.ObjectKey) (*core.Secret, error) { | ||
secret, err := tryGetServiceAccountTokenSecret(kc, sa) | ||
if err == nil { | ||
klog.V(5).Infof("secret found for ServiceAccount %s", sa) | ||
return secret, nil | ||
} | ||
|
||
var saObj core.ServiceAccount | ||
err = kc.Get(context.TODO(), sa, &saObj) | ||
if err != nil { | ||
return nil, errors.Wrapf(err, "failed to get ServiceAccount %s", sa) | ||
} | ||
|
||
secretName := sa.Name + "-token-" + utilrand.String(6) | ||
secret = &core.Secret{ | ||
ObjectMeta: metav1.ObjectMeta{ | ||
Name: secretName, | ||
Namespace: sa.Namespace, | ||
}, | ||
} | ||
vt, err := CreateOrPatch(context.TODO(), kc, secret, func(obj client.Object, createOp bool) client.Object { | ||
in := obj.(*core.Secret) | ||
|
||
in.Type = core.SecretTypeServiceAccountToken | ||
ref := metav1.NewControllerRef(&saObj, core.SchemeGroupVersion.WithKind("ServiceAccount")) | ||
core_util.EnsureOwnerReference(in, ref) | ||
in.Annotations = meta_util.OverwriteKeys(in.Annotations, map[string]string{ | ||
core.ServiceAccountNameKey: sa.Name, | ||
}) | ||
|
||
return in | ||
}) | ||
if err != nil { | ||
return nil, err | ||
} | ||
klog.Infof("%s Secret %s/%s", vt, secret.Namespace, secret.Name) | ||
|
||
return tryGetServiceAccountTokenSecret(kc, sa) | ||
} |
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,120 @@ | ||
/* | ||
Copyright AppsCode Inc. and Contributors | ||
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 v1 | ||
|
||
import ( | ||
"context" | ||
"strings" | ||
"time" | ||
|
||
meta_util "kmodules.xyz/client-go/meta" | ||
|
||
"github.com/pkg/errors" | ||
core "k8s.io/api/core/v1" | ||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
"k8s.io/apimachinery/pkg/types" | ||
utilrand "k8s.io/apimachinery/pkg/util/rand" | ||
"k8s.io/apimachinery/pkg/util/wait" | ||
"k8s.io/client-go/kubernetes" | ||
"k8s.io/klog/v2" | ||
kutil "kmodules.xyz/client-go" | ||
) | ||
|
||
// https://kubernetes.io/docs/reference/access-authn-authz/service-accounts-admin/#token-controller | ||
func getServiceAccountJwtTokenSecret(kc kubernetes.Interface, name, namespace string) (*core.Secret, error) { | ||
secrets, err := kc.CoreV1().Secrets(namespace).List(context.TODO(), metav1.ListOptions{}) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
if len(secrets.Items) == 0 { | ||
return nil, errors.New("token secret still haven't created yet") | ||
} | ||
|
||
// get the token secret | ||
for _, s := range secrets.Items { | ||
if !strings.HasPrefix(s.Name, name+"-token") { | ||
continue | ||
} | ||
return &s, nil | ||
} | ||
return nil, errors.New("token secret is not available") | ||
} | ||
|
||
func tryGetServiceAccountJwtTokenSecret(kc kubernetes.Interface, name string, namespace string, interval time.Duration, timeout time.Duration) (*core.Secret, error) { | ||
var ( | ||
err error | ||
secret *core.Secret | ||
) | ||
err2 := wait.PollImmediate(interval, timeout, func() (bool, error) { | ||
secret, err = getServiceAccountJwtTokenSecret(kc, name, namespace) | ||
if err == nil { | ||
return true, nil | ||
} else { | ||
klog.V(5).Infof("trying to get jwt token secret name from service account %s/%s: %s", namespace, name, err) | ||
} | ||
return false, nil | ||
}) | ||
if err2 != nil { | ||
return nil, errors.Wrap(err, err2.Error()) | ||
} | ||
return secret, nil | ||
} | ||
|
||
func EnsureServiceAccountTokenSecret(kc kubernetes.Interface, sa types.NamespacedName) (*core.Secret, error) { | ||
secret, err := tryGetServiceAccountJwtTokenSecret(kc, sa.Name, sa.Namespace, kutil.RetryInterval, kutil.RetryTimeout) | ||
if err == nil { | ||
klog.Infof("Secret exist for Service Account %s/%s", sa.Namespace, sa.Name) | ||
return secret, nil | ||
} | ||
secretName := sa.Name + "-token-" + utilrand.String(6) | ||
klog.Infof("creating Secret for Service Account %s/%s", sa.Namespace, secretName) | ||
|
||
saObj, err := kc.CoreV1().ServiceAccounts(sa.Namespace).Get(context.TODO(), sa.Name, metav1.GetOptions{}) | ||
if err != nil { | ||
return nil, errors.Wrapf(err, "failed to get ServiceAccount %s/%s", sa.Namespace, sa.Name) | ||
} | ||
|
||
secret = &core.Secret{ | ||
ObjectMeta: metav1.ObjectMeta{ | ||
Name: secretName, | ||
Namespace: sa.Namespace, | ||
}, | ||
} | ||
secret, _, err = CreateOrPatchSecret(context.TODO(), kc, secret.ObjectMeta, func(in *core.Secret) *core.Secret { | ||
in.Type = core.SecretTypeServiceAccountToken | ||
ref := metav1.NewControllerRef(saObj, core.SchemeGroupVersion.WithKind("ServiceAccount")) | ||
EnsureOwnerReference(in, ref) | ||
in.Annotations = meta_util.OverwriteKeys(in.Annotations, map[string]string{ | ||
core.ServiceAccountNameKey: sa.Name, | ||
}) | ||
|
||
return in | ||
}, metav1.PatchOptions{}) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
err = wait.PollImmediate(10*time.Second, 10*time.Minute, func() (done bool, err error) { | ||
secret, err = kc.CoreV1().Secrets(sa.Namespace).Get(context.TODO(), secretName, metav1.GetOptions{}) | ||
if err != nil { | ||
return false, err | ||
} | ||
return true, nil | ||
}) | ||
return secret, err | ||
} |