Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Cascading Cleanup #78

Merged
merged 1 commit into from
Nov 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions charts/region/templates/identity-controller/clusterrole.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,13 @@ rules:
- create
- update
- delete
# Cascading deletion.
- apiGroups:
- region.unikorn-cloud.org
resources:
- quotas
- networks
- securitygroups
- servers
verbs:
- list
- watch
- delete
- apiGroups:
- ""
resources:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,14 +39,6 @@ rules:
- create
- update
- delete
- apiGroups:
- region.unikorn-cloud.org
resources:
- securitygrouprules
verbs:
- list
- watch
- delete
- apiGroups:
- ""
resources:
Expand Down
42 changes: 31 additions & 11 deletions pkg/handler/handler.go
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,20 @@ import (
"github.com/unikorn-cloud/region/pkg/providers"

kerrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/utils/ptr"

"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
)

var (
foregroundDeleteOptions = &client.DeleteOptions{
PropagationPolicy: ptr.To(metav1.DeletePropagationForeground),
}
)

type Handler struct {
// client gives cached access to Kubernetes.
client client.Client
Expand Down Expand Up @@ -109,7 +116,7 @@ func (h *Handler) getNetwork(ctx context.Context, id string) (*unikornv1.Network
return nil, errors.HTTPNotFound().WithError(err)
}

return nil, errors.OAuth2ServerError("unable to physical network identity").WithError(err)
return nil, errors.OAuth2ServerError("unable to network identity").WithError(err)
}

return resource, nil
Expand Down Expand Up @@ -493,7 +500,7 @@ func (h *Handler) DeleteApiV1OrganizationsOrganizationIDProjectsProjectIDIdentit
return
}

if err := h.client.Delete(r.Context(), identity); err != nil {
if err := h.client.Delete(r.Context(), identity, foregroundDeleteOptions); err != nil {
if kerrors.IsNotFound(err) {
errors.HandleError(w, r, errors.HTTPNotFound().WithError(err))
return
Expand Down Expand Up @@ -579,7 +586,7 @@ func (h *Handler) GetApiV1OrganizationsOrganizationIDNetworks(w http.ResponseWri
}

if err := h.client.List(r.Context(), &result, options); err != nil {
errors.HandleError(w, r, errors.OAuth2ServerError("unable to list physical networks").WithError(err))
errors.HandleError(w, r, errors.OAuth2ServerError("unable to list networks").WithError(err))
return
}

Expand Down Expand Up @@ -650,8 +657,14 @@ func (h *Handler) PostApiV1OrganizationsOrganizationIDProjectsProjectIDIdentitie
network.Spec.Tags = generateTagList(request.Spec.Tags)
}

// The resource belongs to its identity, for cascading deletion.
if err := controllerutil.SetOwnerReference(identity, network, h.client.Scheme(), controllerutil.WithBlockOwnerDeletion(true)); err != nil {
errors.HandleError(w, r, errors.OAuth2ServerError("unable to set resource owner").WithError(err))
return
}

if err := h.client.Create(r.Context(), network); err != nil {
errors.HandleError(w, r, errors.OAuth2ServerError("unable to create physical network").WithError(err))
errors.HandleError(w, r, errors.OAuth2ServerError("unable to create network").WithError(err))
return
}

Expand Down Expand Up @@ -685,13 +698,13 @@ func (h *Handler) DeleteApiV1OrganizationsOrganizationIDProjectsProjectIDIdentit
return
}

if err := h.client.Delete(r.Context(), resource); err != nil {
if err := h.client.Delete(r.Context(), resource, foregroundDeleteOptions); err != nil {
if kerrors.IsNotFound(err) {
errors.HandleError(w, r, errors.HTTPNotFound().WithError(err))
return
}

errors.HandleError(w, r, errors.OAuth2ServerError("unable to delete physical network").WithError(err))
errors.HandleError(w, r, errors.OAuth2ServerError("unable to delete network").WithError(err))
return
}

Expand Down Expand Up @@ -819,7 +832,7 @@ func (h *Handler) generateQuota(ctx context.Context, organizationID, projectID s

// Ensure the quota is owned by the identity so it is automatically cleaned
// up on identity deletion.
if err := controllerutil.SetOwnerReference(identity, resource, h.client.Scheme()); err != nil {
if err := controllerutil.SetOwnerReference(identity, resource, h.client.Scheme(), controllerutil.WithBlockOwnerDeletion(true)); err != nil {
return nil, err
}

Expand Down Expand Up @@ -1006,7 +1019,7 @@ func (h *Handler) generateSecurityGroup(ctx context.Context, organizationID, pro

// Ensure the security is owned by the identity so it is automatically cleaned
// up on identity deletion.
if err := controllerutil.SetOwnerReference(identity, resource, h.client.Scheme()); err != nil {
if err := controllerutil.SetOwnerReference(identity, resource, h.client.Scheme(), controllerutil.WithBlockOwnerDeletion(true)); err != nil {
return nil, err
}

Expand Down Expand Up @@ -1076,7 +1089,7 @@ func (h *Handler) DeleteApiV1OrganizationsOrganizationIDProjectsProjectIDIdentit
return
}

if err := h.client.Delete(r.Context(), resource); err != nil {
if err := h.client.Delete(r.Context(), resource, foregroundDeleteOptions); err != nil {
if kerrors.IsNotFound(err) {
errors.HandleError(w, r, errors.HTTPNotFound().WithError(err))
return
Expand Down Expand Up @@ -1313,7 +1326,7 @@ func (h *Handler) generateSecurityGroupRule(ctx context.Context, organizationID,

// Ensure the security is owned by the security group so it is automatically cleaned
// up on security group deletion.
if err := controllerutil.SetOwnerReference(securityGroup, resource, h.client.Scheme()); err != nil {
if err := controllerutil.SetOwnerReference(securityGroup, resource, h.client.Scheme(), controllerutil.WithBlockOwnerDeletion(true)); err != nil {
return nil, err
}

Expand Down Expand Up @@ -1456,7 +1469,14 @@ func (h *Handler) PostApiV1OrganizationsOrganizationIDProjectsProjectIDIdentitie
return
}

result, err := server.NewClient(h.client, h.namespace).Create(r.Context(), organizationID, projectID, identity, request)
// NOTE: exactly 1 is enforced at the API schema level.
network, err := h.getNetwork(r.Context(), request.Spec.Networks[0].Id)
if err != nil {
errors.HandleError(w, r, err)
return
}

result, err := server.NewClient(h.client, h.namespace).Create(r.Context(), organizationID, projectID, identity, network, request)
if err != nil {
errors.HandleError(w, r, err)
return
Expand Down
4 changes: 2 additions & 2 deletions pkg/handler/server/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,9 @@ func (c *Client) List(ctx context.Context, organizationID string) (openapi.Serve
return convertList(result), nil
}

func (c *Client) Create(ctx context.Context, organizationID, projectID string, identity *unikornv1.Identity, request *openapi.ServerWrite) (*openapi.ServerRead, error) {
func (c *Client) Create(ctx context.Context, organizationID, projectID string, identity *unikornv1.Identity, network *unikornv1.Network, request *openapi.ServerWrite) (*openapi.ServerRead, error) {

resource, err := newGenerator(c.client, c.namespace, organizationID, projectID, identity).generate(ctx, request)
resource, err := newGenerator(c.client, c.namespace, organizationID, projectID, identity, network).generate(ctx, request)
if err != nil {
return nil, err
}
Expand Down
11 changes: 7 additions & 4 deletions pkg/handler/server/conversion.go
Original file line number Diff line number Diff line change
Expand Up @@ -182,15 +182,18 @@ type generator struct {
projectID string
// identity is the identity the resource is provisioned for.
identity *unikornv1.Identity
// network is the network tha resource is attacked to.
network *unikornv1.Network
}

func newGenerator(client client.Client, namespace, organizationID, projectID string, identity *unikornv1.Identity) *generator {
func newGenerator(client client.Client, namespace, organizationID, projectID string, identity *unikornv1.Identity, network *unikornv1.Network) *generator {
return &generator{
client: client,
namespace: namespace,
organizationID: organizationID,
projectID: projectID,
identity: identity,
network: network,
}
}

Expand All @@ -214,9 +217,9 @@ func (g *generator) generate(ctx context.Context, in *openapi.ServerWrite) (*uni
},
}

// Ensure the server is owned by the identity so it is automatically cleaned
// up on identity deletion.
if err := controllerutil.SetOwnerReference(g.identity, resource, g.client.Scheme()); err != nil {
// Ensure the server is owned by the network so it is automatically cleaned
// up on cascading deletion.
if err := controllerutil.SetOwnerReference(g.network, resource, g.client.Scheme(), controllerutil.WithBlockOwnerDeletion(true)); err != nil {
return nil, err
}

Expand Down
110 changes: 55 additions & 55 deletions pkg/openapi/schema.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions pkg/openapi/server.spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1217,6 +1217,8 @@ components:
description: A list of networks.
type: array
minItems: 1
# NOTE: this is pinned due to cascading deletion semantics, for now.
maxItems: 1
items:
$ref: '#/components/schemas/serverNetwork'
serverNetwork:
Expand Down
5 changes: 5 additions & 0 deletions pkg/providers/openstack/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -799,6 +799,11 @@ func (p *Provider) DeleteIdentity(ctx context.Context, identity *unikornv1.Ident

defer record()

// User never even created, so nothing else will have been.
if openstackIdentity.Spec.UserID == nil {
return nil
}

// Rescope to the user/project...
providerClient := NewPasswordProvider(p.region.Spec.Openstack.Endpoint, *openstackIdentity.Spec.UserID, *openstackIdentity.Spec.Password, *openstackIdentity.Spec.ProjectID)

Expand Down
Loading