-
Notifications
You must be signed in to change notification settings - Fork 44
/
viewsets.py
1397 lines (1257 loc) · 50 KB
/
viewsets.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""
Check `Plugin Writer's Guide`_ for more details.
. _Plugin Writer's Guide:
http://docs.pulpproject.org/plugins/plugin-writer/index.html
"""
import logging
from gettext import gettext as _
from collections import namedtuple
from django.db import IntegrityError
from django.db.models import Q
from django.http import Http404
from django_filters import CharFilter, MultipleChoiceFilter
from drf_spectacular.utils import extend_schema
from guardian.shortcuts import get_objects_for_user
from rest_framework import mixins
from rest_framework.decorators import action
from rest_framework.exceptions import ValidationError
from pulpcore.plugin.models import RepositoryVersion
from pulpcore.plugin.serializers import (
AsyncOperationResponseSerializer,
RepositorySyncURLSerializer,
)
from pulpcore.plugin.models import Artifact, Content
from pulpcore.plugin.tasking import dispatch, general_multi_delete
from pulpcore.plugin.viewsets import (
AsyncUpdateMixin,
DistributionViewSet,
BaseFilterSet,
CharInFilter,
ContentFilter,
ContentGuardViewSet,
DistributionFilter,
NamedModelViewSet,
NAME_FILTER_OPTIONS,
ReadOnlyContentViewSet,
ReadOnlyRepositoryViewSet,
RemoteViewSet,
RepositoryViewSet,
RepositoryVersionViewSet,
OperationPostponedResponse,
)
from pulp_container.app import access_policy, models, serializers, tasks
log = logging.getLogger(__name__)
class TagFilter(ContentFilter):
"""
FilterSet for Tags.
"""
media_type = MultipleChoiceFilter(
choices=models.Manifest.MANIFEST_CHOICES,
field_name="tagged_manifest__media_type",
lookup_expr="contains",
)
digest = CharInFilter(field_name="tagged_manifest__digest", lookup_expr="in")
class Meta:
model = models.Tag
fields = {
"name": ["exact", "in"],
}
class ManifestFilter(ContentFilter):
"""
FilterSet for Manifests.
"""
media_type = MultipleChoiceFilter(choices=models.Manifest.MANIFEST_CHOICES)
class Meta:
model = models.Manifest
fields = {
"digest": ["exact", "in"],
}
class BlobFilter(ContentFilter):
"""
FilterSet for Blobs.
"""
media_type = MultipleChoiceFilter(choices=models.Blob.BLOB_CHOICES)
class Meta:
model = models.Blob
fields = {
"digest": ["exact", "in"],
}
class ContainerDistributionFilter(DistributionFilter):
"""
FilterSet for ContainerDistributions
"""
namespace__name = CharFilter(lookup_expr="exact")
class Meta:
model = models.ContainerDistribution
fields = DistributionFilter.Meta.fields
class ContainerNamespaceFilter(BaseFilterSet):
"""
FilterSet for ContainerNamespaces
"""
class Meta:
model = models.ContainerNamespace
fields = {
"name": NAME_FILTER_OPTIONS,
}
Repo = namedtuple("Repo", "push_perm, mirror_perm, push_type, mirror_type")
repo_info = Repo(
"container.view_containerpushrepository",
"container.view_containerrepository",
"container.container-push",
"container.container",
)
class ContainerContentQuerySetMixin:
"""
A mixin that provides container content models with querying utilities.
"""
def _repo_query_params(self, request, view, repo_info):
"""
Checks if the requests' query_params contain repository_version.
This is used in the quryset scoping for content.
Args:
request (rest_framework.request.Request): The request being made.
view (subclass rest_framework.viewsets.GenericViewSet): The view being checked for
authorization.
action (str): The action being performed, e.g. "destroy".
repo_info (tuple): Tuple that contains repo type and Permissions to
be checked.
Returns:
List of repositories pk that the current user can view
"""
repo_pks = []
for key, param in request.query_params.items():
if "repository_version" in key:
rv = view.get_resource(param, RepositoryVersion)
repo = rv.repository.cast()
if (
request.user.has_perm(repo_info.push_perm)
and repo.pulp_type == repo_info.push_type
):
repo_pks.append(repo.pk)
elif (
request.user.has_perm(repo_info.mirror_perm)
and repo.pulp_type == repo_info.mirror_type
):
repo_pks.append(repo.pk)
elif request.user.has_perm(repo_info.push_perm, repo) or request.user.has_perm(
repo_info.mirror_perm, repo
):
repo_pks.append(repo.pk)
return repo_pks
def get_queryset(self):
"""
Gets a QuerySet based on the current request.
Filters and retuns the only the repo's content user is allowed to see.
Returns:
django.db.models.query.QuerySet: The queryset returned contains content the user is
allowed to see based on the repo permissions.
"""
qs = super().get_queryset()
has_model_push_repo = self.request.user.has_perm(repo_info.push_perm)
has_model_repo = self.request.user.has_perm(repo_info.mirror_perm)
# this will show also orphaned content
if has_model_push_repo and has_model_repo:
return qs
query_params = self.request.query_params
if query_params and "repository_version" in query_params:
repo_pks = self._repo_query_params(self.request, self, repo_info)
content_qs = qs.model.objects.filter(repositories__in=repo_pks)
else:
allowed_push_repos = get_objects_for_user(
self.request.user,
repo_info.push_perm,
klass=models.ContainerPushRepository,
).only("pk")
allowed_mirror_repos = get_objects_for_user(
self.request.user,
repo_info.mirror_perm,
klass=models.ContainerRepository,
).only("pk")
content_qs = qs.model.objects.filter(
Q(repositories__in=allowed_push_repos) | Q(repositories__in=allowed_mirror_repos)
)
return content_qs
class TagViewSet(ContainerContentQuerySetMixin, ReadOnlyContentViewSet):
"""
ViewSet for Tag.
"""
endpoint_name = "tags"
queryset = models.Tag.objects.all()
serializer_class = serializers.TagSerializer
filterset_class = TagFilter
DEFAULT_ACCESS_POLICY = {
"statements": [
{
"action": ["list"],
"principal": "authenticated",
"effect": "allow",
},
{
"action": ["retrieve"],
"principal": "authenticated",
"effect": "allow",
},
],
}
class ManifestViewSet(ContainerContentQuerySetMixin, ReadOnlyContentViewSet):
"""
ViewSet for Manifest.
"""
endpoint_name = "manifests"
queryset = models.Manifest.objects.all()
serializer_class = serializers.ManifestSerializer
filterset_class = ManifestFilter
DEFAULT_ACCESS_POLICY = {
"statements": [
{
"action": ["list"],
"principal": "authenticated",
"effect": "allow",
},
{
"action": ["retrieve"],
"principal": "authenticated",
"effect": "allow",
},
],
}
class BlobViewSet(ContainerContentQuerySetMixin, ReadOnlyContentViewSet):
"""
ViewSet for Blobs.
"""
endpoint_name = "blobs"
queryset = models.Blob.objects.all()
serializer_class = serializers.BlobSerializer
filterset_class = BlobFilter
DEFAULT_ACCESS_POLICY = {
"statements": [
{
"action": ["list"],
"principal": "authenticated",
"effect": "allow",
},
{
"action": ["retrieve"],
"principal": "authenticated",
"effect": "allow",
},
],
}
class ContainerRemoteViewSet(RemoteViewSet):
"""
Container remotes represent an external repository that implements the Container
Registry API. Container remotes support deferred downloading by configuring
the ``policy`` field. ``on_demand`` and ``streamed`` policies can provide
significant disk space savings.
"""
endpoint_name = "container"
queryset = models.ContainerRemote.objects.all()
serializer_class = serializers.ContainerRemoteSerializer
queryset_filtering_required_permission = "container.view_containerremote"
DEFAULT_ACCESS_POLICY = {
"statements": [
{
"action": ["list"],
"principal": "authenticated",
"effect": "allow",
},
{
"action": ["create"],
"principal": "authenticated",
"effect": "allow",
"condition": "has_model_perms:container.add_containerremote",
},
{
"action": ["retrieve"],
"principal": "authenticated",
"effect": "allow",
"condition": "has_model_or_obj_perms:container.view_containerremote",
},
{
"action": ["update", "partial_update"],
"principal": "authenticated",
"effect": "allow",
"condition": [
"has_model_or_obj_perms:container.change_containerremote",
"has_model_or_obj_perms:container.view_containerremote",
],
},
{
"action": ["destroy"],
"principal": "authenticated",
"effect": "allow",
"condition": [
"has_model_or_obj_perms:container.delete_containerremote",
"has_model_or_obj_perms:container.view_containerremote",
],
},
],
"permissions_assignment": [
{
"function": "add_for_object_creator",
"parameters": None,
"permissions": [
"container.view_containerremote",
"container.change_containerremote",
"container.delete_containerremote",
],
},
],
}
class TagOperationsMixin:
"""
A mixin that adds functionality for creating and deleting tags.
"""
@extend_schema(
description="Trigger an asynchronous task to tag an image in the repository",
summary="Create a Tag",
responses={202: AsyncOperationResponseSerializer},
request=serializers.TagImageSerializer,
)
@action(detail=True, methods=["post"], serializer_class=serializers.TagImageSerializer)
def tag(self, request, pk):
"""
Create a task which is responsible for creating a new tag.
"""
repository = self.get_object()
request.data["repository"] = repository
serializer = serializers.TagImageSerializer(data=request.data, context={"request": request})
serializer.is_valid(raise_exception=True)
manifest = serializer.validated_data["manifest"]
tag = serializer.validated_data["tag"]
result = dispatch(
tasks.tag_image,
exclusive_resources=[repository],
kwargs={
"manifest_pk": str(manifest.pk),
"tag": tag,
"repository_pk": str(repository.pk),
},
)
return OperationPostponedResponse(result, request)
@extend_schema(
description="Trigger an asynchronous task to untag an image in the repository",
summary="Delete a tag",
responses={202: AsyncOperationResponseSerializer},
request=serializers.UnTagImageSerializer,
)
@action(detail=True, methods=["post"], serializer_class=serializers.UnTagImageSerializer)
def untag(self, request, pk):
"""
Create a task which is responsible for untagging an image.
"""
repository = self.get_object()
request.data["repository"] = repository
serializer = serializers.UnTagImageSerializer(
data=request.data, context={"request": request}
)
serializer.is_valid(raise_exception=True)
tag = serializer.validated_data["tag"]
result = dispatch(
tasks.untag_image,
exclusive_resources=[repository],
kwargs={"tag": tag, "repository_pk": str(repository.pk)},
)
return OperationPostponedResponse(result, request)
class RepositoryVersionQuerySetMixin:
"""
A mixin which provides with a custom `get_queryset` method for repository version viewsets.
"""
def get_queryset(self):
"""
Gets a QuerySet based on the current request.
Filtered by a permission for a corresponding repository.
Returns:
django.db.models.query.QuerySet: The queryset returned by the superclass filtered by
the permission for a corresponding repository.
"""
qs = super().get_queryset()
try:
perm = self.queryset_filtering_required_repo_permission
except AttributeError:
pass
else:
repo_version = qs.first()
repo = repo_version.repository.cast()
if not (self.request.user.has_perm(perm) or self.request.user.has_perm(perm, repo)):
raise Http404(_("detail not found"))
return qs
class ContainerRepositoryViewSet(TagOperationsMixin, RepositoryViewSet):
"""
ViewSet for container repo.
"""
endpoint_name = "container"
queryset = models.ContainerRepository.objects.all()
serializer_class = serializers.ContainerRepositorySerializer
queryset_filtering_required_permission = "container.view_containerrepository"
DEFAULT_ACCESS_POLICY = {
"statements": [
{
"action": ["list"],
"principal": "authenticated",
"effect": "allow",
},
{
"action": ["create"],
"principal": "authenticated",
"effect": "allow",
"condition": "has_model_perms:container.add_containerrepository",
},
{
"action": ["retrieve"],
"principal": "authenticated",
"effect": "allow",
"condition": "has_model_or_obj_perms:container.view_containerrepository",
},
{
"action": ["destroy"],
"principal": "authenticated",
"effect": "allow",
"condition": [
"has_model_or_obj_perms:container.delete_containerrepository",
"has_model_or_obj_perms:container.view_containerrepository",
],
},
{
"action": ["update", "partial_update"],
"principal": "authenticated",
"effect": "allow",
"condition": [
"has_model_or_obj_perms:container.change_containerrepository",
"has_model_or_obj_perms:container.view_containerrepository",
],
},
{
"action": ["sync"],
"principal": "authenticated",
"effect": "allow",
"condition": [
"has_model_or_obj_perms:container.sync_containerrepository",
"has_remote_param_model_or_obj_perms:container.view_containerremote",
"has_model_or_obj_perms:container.view_containerrepository",
],
},
{
"action": ["add", "remove", "tag", "untag", "copy_tags", "copy_manifests"],
"principal": "authenticated",
"effect": "allow",
"condition": [
"has_model_or_obj_perms:container.modify_content_containerrepository",
"has_model_or_obj_perms:container.view_containerrepository",
],
},
{
"action": ["build_image"],
"principal": "authenticated",
"effect": "allow",
"condition": [
"has_model_or_obj_perms:container.build_image_containerrepository",
"has_model_or_obj_perms:container.view_containerrepository",
],
},
],
"permissions_assignment": [
{
"function": "add_for_object_creator",
"parameters": None,
"permissions": [
"container.view_containerrepository",
"container.change_containerrepository",
"container.delete_containerrepository",
"container.delete_containerrepository_versions",
"container.sync_containerrepository",
"container.modify_content_containerrepository",
"container.build_image_containerrepository",
],
},
],
}
# This decorator is necessary since a sync operation is asyncrounous and returns
# the id and href of the sync task.
@extend_schema(
description="Trigger an asynchronous task to sync content.",
summary="Sync from a remote",
responses={202: AsyncOperationResponseSerializer},
)
@action(detail=True, methods=["post"], serializer_class=RepositorySyncURLSerializer)
def sync(self, request, pk):
"""
Synchronizes a repository. The ``repository`` field has to be provided.
"""
repository = self.get_object()
serializer = RepositorySyncURLSerializer(
data=request.data, context={"request": request, "repository_pk": pk}
)
# Validate synchronously to return 400 errors.
serializer.is_valid(raise_exception=True)
remote = serializer.validated_data.get("remote", repository.remote)
mirror = serializer.validated_data.get("mirror")
result = dispatch(
tasks.synchronize,
shared_resources=[remote],
exclusive_resources=[repository],
kwargs={
"remote_pk": str(remote.pk),
"repository_pk": str(repository.pk),
"mirror": mirror,
},
)
return OperationPostponedResponse(result, request)
@extend_schema(
description="Trigger an asynchronous task to recursively add container content.",
summary="Add content",
responses={202: AsyncOperationResponseSerializer},
request=serializers.RecursiveManageSerializer,
)
@action(detail=True, methods=["post"], serializer_class=serializers.RecursiveManageSerializer)
def add(self, request, pk):
"""
Queues a task that creates a new RepositoryVersion by adding content units.
"""
add_content_units = {}
repository = self.get_object()
serializer = serializers.RecursiveManageSerializer(data=request.data)
serializer.is_valid(raise_exception=True)
if "content_units" in request.data:
for url in request.data["content_units"]:
add_content_units[NamedModelViewSet.extract_pk(url)] = url
self.touch_content_units(add_content_units)
result = dispatch(
tasks.recursive_add_content,
exclusive_resources=[repository],
kwargs={
"repository_pk": repository.pk,
"content_units": list(add_content_units.keys()),
},
)
return OperationPostponedResponse(result, request)
def touch_content_units(self, content_units):
"""Touch and validate referenced content units."""
content_units_pks = content_units.keys()
existing_content_units = Content.objects.filter(pk__in=content_units_pks)
existing_content_units.touch()
existing_content_units_pks = existing_content_units.values_list("pk", flat=True)
existing_content_units_pks = {str(pk) for pk in existing_content_units_pks}
missing_pks = content_units_pks - existing_content_units_pks
if missing_pks:
missing_hrefs = [content_units[pk] for pk in missing_pks]
raise ValidationError(
_("Could not find the following content units: {}").format(missing_hrefs)
)
@extend_schema(
description="Trigger an async task to recursively remove container content.",
summary="Remove content",
responses={202: AsyncOperationResponseSerializer},
request=serializers.RecursiveManageSerializer,
)
@action(detail=True, methods=["post"], serializer_class=serializers.RecursiveManageSerializer)
def remove(self, request, pk):
"""
Queues a task that creates a new RepositoryVersion by removing content units.
"""
remove_content_units = []
repository = self.get_object()
serializer = serializers.RecursiveManageSerializer(data=request.data)
serializer.is_valid(raise_exception=True)
if "content_units" in request.data:
for url in request.data["content_units"]:
if url == "*":
remove_content_units = [url]
break
content = NamedModelViewSet.get_resource(url, Content)
remove_content_units.append(str(content.pk))
result = dispatch(
tasks.recursive_remove_content,
exclusive_resources=[repository],
kwargs={"repository_pk": str(repository.pk), "content_units": remove_content_units},
)
return OperationPostponedResponse(result, request)
@extend_schema(
description="Trigger an asynchronous task to copy tags",
summary="Copy tags",
responses={202: AsyncOperationResponseSerializer},
request=serializers.TagCopySerializer,
)
@action(detail=True, methods=["post"], serializer_class=serializers.TagCopySerializer)
def copy_tags(self, request, pk):
"""
Queues a task that creates a new RepositoryVersion by adding Tags.
"""
names = request.data.get("names")
serializer = serializers.TagCopySerializer(data=request.data)
serializer.is_valid(raise_exception=True)
repository = self.get_object()
source_latest = serializer.validated_data["source_repository_version"]
content_tags_in_repo = source_latest.content.filter(pulp_type=models.Tag.get_pulp_type())
tags_in_repo = models.Tag.objects.filter(pk__in=content_tags_in_repo)
if names is None:
tags_to_add = tags_in_repo
else:
tags_to_add = tags_in_repo.filter(name__in=names)
result = dispatch(
tasks.recursive_add_content,
shared_resources=[source_latest.repository],
exclusive_resources=[repository],
kwargs={
"repository_pk": str(repository.pk),
"content_units": [str(pk) for pk in tags_to_add.values_list("pk", flat=True)],
},
)
return OperationPostponedResponse(result, request)
@extend_schema(
description="Trigger an asynchronous task to copy manifests",
summary="Copy manifests",
responses={202: AsyncOperationResponseSerializer},
request=serializers.ManifestCopySerializer,
)
@action(detail=True, methods=["post"], serializer_class=serializers.ManifestCopySerializer)
def copy_manifests(self, request, pk):
"""
Queues a task that creates a new RepositoryVersion by adding Manifests.
"""
serializer = serializers.ManifestCopySerializer(data=request.data)
serializer.is_valid(raise_exception=True)
repository = self.get_object()
source_latest = serializer.validated_data["source_repository_version"]
content_manifests_in_repo = source_latest.content.filter(
pulp_type=models.Manifest.get_pulp_type()
)
manifests_in_repo = models.Manifest.objects.filter(pk__in=content_manifests_in_repo)
digests = request.data.get("digests")
media_types = request.data.get("media_types")
filters = {}
if digests is not None:
filters["digest__in"] = digests
if media_types is not None:
filters["media_type__in"] = media_types
manifests_to_add = manifests_in_repo.filter(**filters)
result = dispatch(
tasks.recursive_add_content,
shared_resources=[source_latest.repository],
exclusive_resources=[repository],
kwargs={
"repository_pk": str(repository.pk),
"content_units": [str(manifest.pk) for manifest in manifests_to_add],
},
)
return OperationPostponedResponse(result, request)
@extend_schema(
description="Trigger an asynchronous task to build an OCI image from a "
"Containerfile. A new repository version is created with the new "
"image and tag. This API is tech preview in Pulp Container 1.1. "
"Backwards compatibility when upgrading is not guaranteed.",
summary="Build an Image",
responses={202: AsyncOperationResponseSerializer},
request=serializers.OCIBuildImageSerializer,
)
@action(detail=True, methods=["post"], serializer_class=serializers.TagImageSerializer)
def build_image(self, request, pk):
"""
Create a task which is responsible for creating a new image and tag.
"""
repository = self.get_object()
serializer = serializers.OCIBuildImageSerializer(
data=request.data, context={"request": request}
)
serializer.is_valid(raise_exception=True)
containerfile = serializer.validated_data["containerfile_artifact"]
try:
containerfile.save()
except IntegrityError:
containerfile = Artifact.objects.get(sha256=containerfile.sha256)
containerfile.touch()
tag = serializer.validated_data["tag"]
artifacts = serializer.validated_data["artifacts"]
for artifact in artifacts:
artifact.touch()
result = dispatch(
tasks.build_image_from_containerfile,
exclusive_resources=[repository],
kwargs={
"containerfile_pk": str(containerfile.pk),
"tag": tag,
"repository_pk": str(repository.pk),
"artifacts": artifacts,
},
)
return OperationPostponedResponse(result, request)
class ContainerRepositoryVersionViewSet(RepositoryVersionQuerySetMixin, RepositoryVersionViewSet):
"""
ContainerRepositoryVersion represents a single container repository version.
"""
parent_viewset = ContainerRepositoryViewSet
queryset_filtering_required_repo_permission = "container.view_containerrepository"
DEFAULT_ACCESS_POLICY = {
"statements": [
{
"action": ["list"],
"principal": "authenticated",
"effect": "allow",
},
{
"action": ["retrieve"],
"principal": "authenticated",
"effect": "allow",
"condition": "has_repo_attr_model_or_obj_perms:container.view_containerrepository",
},
{
"action": ["destroy"],
"principal": "authenticated",
"effect": "allow",
"condition": [
"has_repo_attr_model_or_obj_perms:container.delete_containerrepository_versions", # noqa
"has_repo_attr_model_or_obj_perms:container.view_containerrepository",
],
},
{
"action": ["destroy"],
"principal": "authenticated",
"effect": "allow",
"condition": [
"has_repo_attr_model_or_obj_perms:container.delete_containerrepository",
"has_repo_attr_model_or_obj_perms:container.view_containerrepository",
],
},
{
"action": ["repair"],
"principal": "authenticated",
"effect": "allow",
"condition": [
"has_repo_attr_model_or_obj_perms:container.sync_containerrepository",
"has_repo_attr_model_or_obj_perms:container.view_containerrepository",
],
},
],
}
class ContainerPushRepositoryViewSet(
TagOperationsMixin, ReadOnlyRepositoryViewSet, AsyncUpdateMixin
):
"""
ViewSet for a container push repository.
POST and DELETE are disallowed because a push repository is tightly coupled with a
ContainerDistribution which handles it automatically.
Created - during push operation, removed - with ContainerDistribution removal.
"""
endpoint_name = "container-push"
queryset = models.ContainerPushRepository.objects.all()
serializer_class = serializers.ContainerPushRepositorySerializer
permission_classes = (access_policy.NamespacedAccessPolicyFromDB,)
DEFAULT_ACCESS_POLICY = {
"statements": [
{
"action": ["list"],
"principal": "authenticated",
"effect": "allow",
},
{
"action": ["retrieve"],
"principal": "authenticated",
"effect": "allow",
"condition": "has_namespace_or_obj_perms:container.view_containerpushrepository",
},
{
"action": ["tag", "untag", "remove_image"],
"principal": "authenticated",
"effect": "allow",
"condition": [
"has_namespace_or_obj_perms:container.modify_content_containerpushrepository",
"has_namespace_or_obj_perms:container.view_containerpushrepository",
],
},
{
"action": ["update", "partial_update"],
"principal": "authenticated",
"effect": "allow",
"condition": [
"has_namespace_or_obj_perms:container.change_containerpushrepository",
"has_namespace_or_obj_perms:container.view_containerpushrepository",
],
},
],
"permissions_assignment": [
{
"function": "add_perms_to_distribution_group",
"parameters": {
"group_type": "owners",
"add_user_to_group": True,
},
"permissions": [
"container.view_containerpushrepository",
"container.modify_content_containerpushrepository",
"container.change_containerpushrepository",
],
},
{
"function": "add_perms_to_distribution_group",
"parameters": {
"group_type": "collaborators",
"add_user_to_group": False,
},
"permissions": [
"container.view_containerpushrepository",
"container.modify_content_containerpushrepository",
"container.change_containerpushrepository",
],
},
{
"function": "add_perms_to_distribution_group",
"parameters": {
"group_type": "consumers",
"add_user_to_group": False,
},
"permissions": [
"container.view_containerpushrepository",
],
},
],
}
@extend_schema(
description=(
"Trigger an asynchronous task to remove a manifest and all its associated "
"data by a digest"
),
summary="Delete an image from a repository",
responses={202: AsyncOperationResponseSerializer},
request=serializers.RemoveImageSerializer,
)
@action(detail=True, methods=["post"], serializer_class=serializers.RemoveImageSerializer)
def remove_image(self, request, pk):
"""
Create a task which deletes an image by the passed digest.
"""
repository = self.get_object()
request.data["repository"] = repository
serializer = serializers.RemoveImageSerializer(
data=request.data, context={"request": request}
)
serializer.is_valid(raise_exception=True)
content_units_to_remove = list(serializer.validated_data["tags_pks"])
content_units_to_remove.append(serializer.validated_data["manifest"].pk)
result = dispatch(
tasks.recursive_remove_content,
exclusive_resources=[repository],
kwargs={
"repository_pk": str(repository.pk),
"content_units": [str(pk) for pk in content_units_to_remove],
},
)
return OperationPostponedResponse(result, request)
def get_queryset(self):
"""
Returns a queryset by filtering by namespace permission to view distributions and
distribution level permissions.
"""
qs = models.ContainerPushRepository.objects.all()
namespaces = get_objects_for_user(self.request.user, "container.view_containernamespace")
ns_repository_pks = models.ContainerDistribution.objects.filter(
namespace__in=namespaces
).values_list("repository")
dist_repository_pks = get_objects_for_user(
self.request.user, "container.view_containerdistribution"
).values_list("repository")
public_repository_pks = models.ContainerDistribution.objects.filter(
private=False
).values_list("repository")
return qs.filter(
Q(pk__in=ns_repository_pks)
| Q(pk__in=dist_repository_pks)
| Q(pk__in=public_repository_pks)
)
class ContainerPushRepositoryVersionViewSet(
RepositoryVersionQuerySetMixin,
RepositoryVersionViewSet,
):
"""
ContainerPushRepositoryVersion represents a single container push repository version.
Repository versions of a push repository are not allowed to be deleted. Versioning of such
repositories, as well as creation/removal, happens automatically without explicit user actions.
Users could make a repository not functional by accident if allowed to delete repository
versions.
"""
parent_viewset = ContainerPushRepositoryViewSet
queryset_filtering_required_repo_permission = "container.view_containerpushrepository"
DEFAULT_ACCESS_POLICY = {
"statements": [
{
"action": ["list"],
"principal": "authenticated",
"effect": "allow",
},