mirror of
https://github.com/1Password/onepassword-operator.git
synced 2025-10-22 07:28:06 +00:00
Implement the OnePasswordItem Controller
- Migrate the functionality of the Controller for the OnePasswordItem resource. - Add the RBAC markers that will generate the RBAC permissions. - Run `make manifests` to generate the RBAC permissions.
This commit is contained in:
@@ -5,6 +5,81 @@ metadata:
|
|||||||
creationTimestamp: null
|
creationTimestamp: null
|
||||||
name: manager-role
|
name: manager-role
|
||||||
rules:
|
rules:
|
||||||
|
- apiGroups:
|
||||||
|
- ""
|
||||||
|
resources:
|
||||||
|
- configmaps
|
||||||
|
- endpoints
|
||||||
|
- events
|
||||||
|
- namespaces
|
||||||
|
- persistentvolumeclaims
|
||||||
|
- pods
|
||||||
|
- secrets
|
||||||
|
- services
|
||||||
|
- services/finalizers
|
||||||
|
verbs:
|
||||||
|
- create
|
||||||
|
- delete
|
||||||
|
- get
|
||||||
|
- list
|
||||||
|
- patch
|
||||||
|
- update
|
||||||
|
- watch
|
||||||
|
- apiGroups:
|
||||||
|
- ""
|
||||||
|
resources:
|
||||||
|
- pods
|
||||||
|
verbs:
|
||||||
|
- get
|
||||||
|
- apiGroups:
|
||||||
|
- apps
|
||||||
|
resources:
|
||||||
|
- daemonsets
|
||||||
|
- deployments
|
||||||
|
- replicasets
|
||||||
|
- statefulsets
|
||||||
|
verbs:
|
||||||
|
- create
|
||||||
|
- delete
|
||||||
|
- get
|
||||||
|
- list
|
||||||
|
- patch
|
||||||
|
- update
|
||||||
|
- watch
|
||||||
|
- apiGroups:
|
||||||
|
- apps
|
||||||
|
resources:
|
||||||
|
- deployments
|
||||||
|
- replicasets
|
||||||
|
verbs:
|
||||||
|
- get
|
||||||
|
- apiGroups:
|
||||||
|
- apps
|
||||||
|
resourceNames:
|
||||||
|
- onepassword-connect-operator
|
||||||
|
resources:
|
||||||
|
- deployments/finalizers
|
||||||
|
verbs:
|
||||||
|
- update
|
||||||
|
- apiGroups:
|
||||||
|
- monitoring.coreos.com
|
||||||
|
resources:
|
||||||
|
- servicemonitors
|
||||||
|
verbs:
|
||||||
|
- create
|
||||||
|
- get
|
||||||
|
- apiGroups:
|
||||||
|
- onepassword.com
|
||||||
|
resources:
|
||||||
|
- '*'
|
||||||
|
verbs:
|
||||||
|
- create
|
||||||
|
- delete
|
||||||
|
- get
|
||||||
|
- list
|
||||||
|
- patch
|
||||||
|
- update
|
||||||
|
- watch
|
||||||
- apiGroups:
|
- apiGroups:
|
||||||
- onepassword.com
|
- onepassword.com
|
||||||
resources:
|
resources:
|
||||||
|
@@ -26,25 +26,46 @@ package controllers
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"github.com/1Password/connect-sdk-go/connect"
|
||||||
|
|
||||||
|
onepasswordv1 "github.com/1Password/onepassword-operator/api/v1"
|
||||||
|
kubeSecrets "github.com/1Password/onepassword-operator/pkg/kubernetessecrets"
|
||||||
|
op "github.com/1Password/onepassword-operator/pkg/onepassword"
|
||||||
|
"github.com/1Password/onepassword-operator/pkg/utils"
|
||||||
|
|
||||||
|
corev1 "k8s.io/api/core/v1"
|
||||||
|
"k8s.io/apimachinery/pkg/api/errors"
|
||||||
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||||
"k8s.io/apimachinery/pkg/runtime"
|
"k8s.io/apimachinery/pkg/runtime"
|
||||||
ctrl "sigs.k8s.io/controller-runtime"
|
ctrl "sigs.k8s.io/controller-runtime"
|
||||||
"sigs.k8s.io/controller-runtime/pkg/client"
|
"sigs.k8s.io/controller-runtime/pkg/client"
|
||||||
"sigs.k8s.io/controller-runtime/pkg/log"
|
"sigs.k8s.io/controller-runtime/pkg/client/apiutil"
|
||||||
|
logf "sigs.k8s.io/controller-runtime/pkg/log"
|
||||||
onepasswordcomv1 "github.com/1Password/onepassword-operator/api/v1"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
var logOnePasswordItem = logf.Log.WithName("controller_onepassworditem")
|
||||||
|
var finalizer = "onepassword.com/finalizer.secret"
|
||||||
|
|
||||||
// OnePasswordItemReconciler reconciles a OnePasswordItem object
|
// OnePasswordItemReconciler reconciles a OnePasswordItem object
|
||||||
type OnePasswordItemReconciler struct {
|
type OnePasswordItemReconciler struct {
|
||||||
client.Client
|
client.Client
|
||||||
Scheme *runtime.Scheme
|
Scheme *runtime.Scheme
|
||||||
|
OpConnectClient connect.Client
|
||||||
}
|
}
|
||||||
|
|
||||||
//+kubebuilder:rbac:groups=onepassword.com,resources=onepassworditems,verbs=get;list;watch;create;update;patch;delete
|
//+kubebuilder:rbac:groups=onepassword.com,resources=onepassworditems,verbs=get;list;watch;create;update;patch;delete
|
||||||
//+kubebuilder:rbac:groups=onepassword.com,resources=onepassworditems/status,verbs=get;update;patch
|
//+kubebuilder:rbac:groups=onepassword.com,resources=onepassworditems/status,verbs=get;update;patch
|
||||||
//+kubebuilder:rbac:groups=onepassword.com,resources=onepassworditems/finalizers,verbs=update
|
//+kubebuilder:rbac:groups=onepassword.com,resources=onepassworditems/finalizers,verbs=update
|
||||||
|
|
||||||
|
//+kubebuilder:rbac:groups="",resources=pods,verbs=get
|
||||||
|
//+kubebuilder:rbac:groups="",resources=pods;services;services/finalizers;endpoints;persistentvolumeclaims;events;configmaps;secrets;namespaces,verbs=get;list;watch;create;update;patch;delete
|
||||||
|
//+kubebuilder:rbac:groups=apps,resources=daemonsets;deployments;replicasets;statefulsets,verbs=get;list;watch;create;update;patch;delete
|
||||||
|
//+kubebuilder:rbac:groups=apps,resources=replicasets;deployments,verbs=get
|
||||||
|
//+kubebuilder:rbac:groups=apps,resourceNames=onepassword-connect-operator,resources=deployments/finalizers,verbs=update
|
||||||
|
//+kubebuilder:rbac:groups=onepassword.com,resources=*,verbs=get;list;watch;create;update;patch;delete
|
||||||
|
//+kubebuilder:rbac:groups=monitoring.coreos.com,resources=servicemonitors,verbs=get;create
|
||||||
|
|
||||||
// Reconcile is part of the main kubernetes reconciliation loop which aims to
|
// Reconcile is part of the main kubernetes reconciliation loop which aims to
|
||||||
// move the current state of the cluster closer to the desired state.
|
// move the current state of the cluster closer to the desired state.
|
||||||
// TODO(user): Modify the Reconcile function to compare the state specified by
|
// TODO(user): Modify the Reconcile function to compare the state specified by
|
||||||
@@ -53,18 +74,141 @@ type OnePasswordItemReconciler struct {
|
|||||||
// the user.
|
// the user.
|
||||||
//
|
//
|
||||||
// For more details, check Reconcile and its Result here:
|
// For more details, check Reconcile and its Result here:
|
||||||
// - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.12.2/pkg/reconcile
|
// - https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/reconcile
|
||||||
func (r *OnePasswordItemReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
|
func (r *OnePasswordItemReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
|
||||||
_ = log.FromContext(ctx)
|
reqLogger := logOnePasswordItem.WithValues("Request.Namespace", req.Namespace, "Request.Name", req.Name)
|
||||||
|
reqLogger.Info("Reconciling OnePasswordItem")
|
||||||
|
|
||||||
// TODO(user): your logic here
|
onepassworditem := &onepasswordv1.OnePasswordItem{}
|
||||||
|
err := r.Get(context.Background(), req.NamespacedName, onepassworditem)
|
||||||
|
if err != nil {
|
||||||
|
if errors.IsNotFound(err) {
|
||||||
|
return ctrl.Result{}, nil
|
||||||
|
}
|
||||||
|
return ctrl.Result{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// If the deployment is not being deleted
|
||||||
|
if onepassworditem.ObjectMeta.DeletionTimestamp.IsZero() {
|
||||||
|
// Adds a finalizer to the deployment if one does not exist.
|
||||||
|
// This is so we can handle cleanup of associated secrets properly
|
||||||
|
if !utils.ContainsString(onepassworditem.ObjectMeta.Finalizers, finalizer) {
|
||||||
|
onepassworditem.ObjectMeta.Finalizers = append(onepassworditem.ObjectMeta.Finalizers, finalizer)
|
||||||
|
if err := r.Update(context.Background(), onepassworditem); err != nil {
|
||||||
|
return ctrl.Result{}, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Handles creation or updating secrets for deployment if needed
|
||||||
|
err := r.handleOnePasswordItem(onepassworditem, req)
|
||||||
|
if updateStatusErr := r.updateStatus(onepassworditem, err); updateStatusErr != nil {
|
||||||
|
return ctrl.Result{}, fmt.Errorf("cannot update status: %s", updateStatusErr)
|
||||||
|
}
|
||||||
|
return ctrl.Result{}, err
|
||||||
|
}
|
||||||
|
// If one password finalizer exists then we must cleanup associated secrets
|
||||||
|
if utils.ContainsString(onepassworditem.ObjectMeta.Finalizers, finalizer) {
|
||||||
|
|
||||||
|
// Delete associated kubernetes secret
|
||||||
|
if err = r.cleanupKubernetesSecret(onepassworditem); err != nil {
|
||||||
|
return ctrl.Result{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Remove finalizer now that cleanup is complete
|
||||||
|
if err := r.removeFinalizer(onepassworditem); err != nil {
|
||||||
|
return ctrl.Result{}, err
|
||||||
|
}
|
||||||
|
}
|
||||||
return ctrl.Result{}, nil
|
return ctrl.Result{}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetupWithManager sets up the controller with the Manager.
|
// SetupWithManager sets up the controller with the Manager.
|
||||||
func (r *OnePasswordItemReconciler) SetupWithManager(mgr ctrl.Manager) error {
|
func (r *OnePasswordItemReconciler) SetupWithManager(mgr ctrl.Manager) error {
|
||||||
return ctrl.NewControllerManagedBy(mgr).
|
return ctrl.NewControllerManagedBy(mgr).
|
||||||
For(&onepasswordcomv1.OnePasswordItem{}).
|
For(&onepasswordv1.OnePasswordItem{}).
|
||||||
Complete(r)
|
Complete(r)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (r *OnePasswordItemReconciler) removeFinalizer(onePasswordItem *onepasswordv1.OnePasswordItem) error {
|
||||||
|
onePasswordItem.ObjectMeta.Finalizers = utils.RemoveString(onePasswordItem.ObjectMeta.Finalizers, finalizer)
|
||||||
|
if err := r.Update(context.Background(), onePasswordItem); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *OnePasswordItemReconciler) cleanupKubernetesSecret(onePasswordItem *onepasswordv1.OnePasswordItem) error {
|
||||||
|
kubernetesSecret := &corev1.Secret{}
|
||||||
|
kubernetesSecret.ObjectMeta.Name = onePasswordItem.Name
|
||||||
|
kubernetesSecret.ObjectMeta.Namespace = onePasswordItem.Namespace
|
||||||
|
|
||||||
|
r.Delete(context.Background(), kubernetesSecret)
|
||||||
|
if err := r.Delete(context.Background(), kubernetesSecret); err != nil {
|
||||||
|
if !errors.IsNotFound(err) {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *OnePasswordItemReconciler) removeOnePasswordFinalizerFromOnePasswordItem(opSecret *onepasswordv1.OnePasswordItem) error {
|
||||||
|
opSecret.ObjectMeta.Finalizers = utils.RemoveString(opSecret.ObjectMeta.Finalizers, finalizer)
|
||||||
|
return r.Update(context.Background(), opSecret)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *OnePasswordItemReconciler) handleOnePasswordItem(resource *onepasswordv1.OnePasswordItem, req ctrl.Request) error {
|
||||||
|
secretName := resource.GetName()
|
||||||
|
labels := resource.Labels
|
||||||
|
secretType := resource.Type
|
||||||
|
autoRestart := resource.Annotations[op.RestartDeploymentsAnnotation]
|
||||||
|
|
||||||
|
item, err := op.GetOnePasswordItemByPath(r.OpConnectClient, resource.Spec.ItemPath)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("Failed to retrieve item: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create owner reference.
|
||||||
|
gvk, err := apiutil.GVKForObject(resource, r.Scheme)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("could not to retrieve group version kind: %v", err)
|
||||||
|
}
|
||||||
|
ownerRef := &metav1.OwnerReference{
|
||||||
|
APIVersion: gvk.GroupVersion().String(),
|
||||||
|
Kind: gvk.Kind,
|
||||||
|
Name: resource.GetName(),
|
||||||
|
UID: resource.GetUID(),
|
||||||
|
}
|
||||||
|
|
||||||
|
return kubeSecrets.CreateKubernetesSecretFromItem(r.Client, secretName, resource.Namespace, item, autoRestart, labels, secretType, ownerRef)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *OnePasswordItemReconciler) updateStatus(resource *onepasswordv1.OnePasswordItem, err error) error {
|
||||||
|
existingCondition := findCondition(resource.Status.Conditions, onepasswordv1.OnePasswordItemReady)
|
||||||
|
updatedCondition := existingCondition
|
||||||
|
if err != nil {
|
||||||
|
updatedCondition.Message = err.Error()
|
||||||
|
updatedCondition.Status = metav1.ConditionFalse
|
||||||
|
} else {
|
||||||
|
updatedCondition.Message = ""
|
||||||
|
updatedCondition.Status = metav1.ConditionTrue
|
||||||
|
}
|
||||||
|
|
||||||
|
if existingCondition.Status != updatedCondition.Status {
|
||||||
|
updatedCondition.LastTransitionTime = metav1.Now()
|
||||||
|
}
|
||||||
|
|
||||||
|
resource.Status.Conditions = []onepasswordv1.OnePasswordItemCondition{updatedCondition}
|
||||||
|
return r.Status().Update(context.Background(), resource)
|
||||||
|
}
|
||||||
|
|
||||||
|
func findCondition(conditions []onepasswordv1.OnePasswordItemCondition, t onepasswordv1.OnePasswordItemConditionType) onepasswordv1.OnePasswordItemCondition {
|
||||||
|
for _, c := range conditions {
|
||||||
|
if c.Type == t {
|
||||||
|
return c
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return onepasswordv1.OnePasswordItemCondition{
|
||||||
|
Type: t,
|
||||||
|
Status: metav1.ConditionUnknown,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Reference in New Issue
Block a user