|
| 1 | +package prune |
| 2 | + |
| 3 | +import ( |
| 4 | + "fmt" |
| 5 | + |
| 6 | + "github.com/docker/distribution" |
| 7 | + "github.com/docker/distribution/context" |
| 8 | + "github.com/docker/distribution/digest" |
| 9 | + "github.com/docker/distribution/manifest/schema2" |
| 10 | + "github.com/docker/distribution/reference" |
| 11 | + "github.com/docker/distribution/registry/storage" |
| 12 | + "github.com/docker/distribution/registry/storage/driver" |
| 13 | + |
| 14 | + kerrors "k8s.io/apimachinery/pkg/api/errors" |
| 15 | + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" |
| 16 | + |
| 17 | + "github.com/openshift/origin/pkg/dockerregistry/server" |
| 18 | + imageapi "github.com/openshift/origin/pkg/image/apis/image" |
| 19 | +) |
| 20 | + |
| 21 | +func imageStreamHasManifestDigest(is *imageapi.ImageStream, dgst digest.Digest) bool { |
| 22 | + for _, tagEventList := range is.Status.Tags { |
| 23 | + for _, tagEvent := range tagEventList.Items { |
| 24 | + if tagEvent.Image == string(dgst) { |
| 25 | + return true |
| 26 | + } |
| 27 | + } |
| 28 | + } |
| 29 | + return false |
| 30 | +} |
| 31 | + |
| 32 | +// Summary is cumulative information about what was pruned. |
| 33 | +type Summary struct { |
| 34 | + Blobs int |
| 35 | + DiskSpace int64 |
| 36 | +} |
| 37 | + |
| 38 | +// Prune removes blobs which are not used by Images in OpenShift. |
| 39 | +// |
| 40 | +// On error, the Summary will contain what was deleted so far. |
| 41 | +// |
| 42 | +// TODO(dmage): remove layer links to a blob if the blob is removed or it doesn't belong to the ImageStream. |
| 43 | +// TODO(dmage): keep young blobs (docker/distribution#2297). |
| 44 | +func Prune(ctx context.Context, storageDriver driver.StorageDriver, registry distribution.Namespace, registryClient server.RegistryClient, dryRun bool) (Summary, error) { |
| 45 | + logger := context.GetLogger(ctx) |
| 46 | + |
| 47 | + repositoryEnumerator, ok := registry.(distribution.RepositoryEnumerator) |
| 48 | + if !ok { |
| 49 | + return Summary{}, fmt.Errorf("unable to convert Namespace to RepositoryEnumerator") |
| 50 | + } |
| 51 | + |
| 52 | + oc, _, err := registryClient.Clients() |
| 53 | + if err != nil { |
| 54 | + return Summary{}, fmt.Errorf("error getting clients: %v", err) |
| 55 | + } |
| 56 | + |
| 57 | + imageList, err := oc.Images().List(metav1.ListOptions{}) |
| 58 | + if err != nil { |
| 59 | + return Summary{}, fmt.Errorf("error listing images: %v", err) |
| 60 | + } |
| 61 | + |
| 62 | + inuse := make(map[string]string) |
| 63 | + for _, image := range imageList.Items { |
| 64 | + // Keep the manifest. |
| 65 | + inuse[image.Name] = image.DockerImageReference |
| 66 | + |
| 67 | + // Keep the config for a schema 2 manifest. |
| 68 | + if image.DockerImageManifestMediaType == schema2.MediaTypeManifest { |
| 69 | + inuse[image.DockerImageMetadata.ID] = image.DockerImageReference |
| 70 | + } |
| 71 | + |
| 72 | + // Keep image layers. |
| 73 | + for _, layer := range image.DockerImageLayers { |
| 74 | + inuse[layer.Name] = image.DockerImageReference |
| 75 | + } |
| 76 | + } |
| 77 | + |
| 78 | + var stats Summary |
| 79 | + |
| 80 | + var reposToDelete []string |
| 81 | + err = repositoryEnumerator.Enumerate(ctx, func(repoName string) error { |
| 82 | + logger.Debugln("Processing repository", repoName) |
| 83 | + |
| 84 | + named, err := reference.WithName(repoName) |
| 85 | + if err != nil { |
| 86 | + return fmt.Errorf("failed to parse the repo name %s: %v", repoName, err) |
| 87 | + } |
| 88 | + |
| 89 | + ref, err := imageapi.ParseDockerImageReference(repoName) |
| 90 | + if err != nil { |
| 91 | + return fmt.Errorf("failed to parse the image reference %s: %v", repoName, err) |
| 92 | + } |
| 93 | + |
| 94 | + is, err := oc.ImageStreams(ref.Namespace).Get(ref.Name, metav1.GetOptions{}) |
| 95 | + if kerrors.IsNotFound(err) { |
| 96 | + logger.Printf("The image stream %s/%s is not found, will remove the whole repository", ref.Namespace, ref.Name) |
| 97 | + |
| 98 | + // We cannot delete the repository at this point, because it would break Enumerate. |
| 99 | + reposToDelete = append(reposToDelete, repoName) |
| 100 | + |
| 101 | + return nil |
| 102 | + } else if err != nil { |
| 103 | + return fmt.Errorf("failed to get the image stream %s: %v", repoName, err) |
| 104 | + } |
| 105 | + |
| 106 | + repository, err := registry.Repository(ctx, named) |
| 107 | + if err != nil { |
| 108 | + return err |
| 109 | + } |
| 110 | + |
| 111 | + manifestService, err := repository.Manifests(ctx) |
| 112 | + if err != nil { |
| 113 | + return err |
| 114 | + } |
| 115 | + |
| 116 | + manifestEnumerator, ok := manifestService.(distribution.ManifestEnumerator) |
| 117 | + if !ok { |
| 118 | + return fmt.Errorf("unable to convert ManifestService into ManifestEnumerator") |
| 119 | + } |
| 120 | + |
| 121 | + err = manifestEnumerator.Enumerate(ctx, func(dgst digest.Digest) error { |
| 122 | + if _, ok := inuse[string(dgst)]; ok && imageStreamHasManifestDigest(is, dgst) { |
| 123 | + logger.Debugf("Keeping the manifest link %s@%s", repoName, dgst) |
| 124 | + return nil |
| 125 | + } |
| 126 | + |
| 127 | + if dryRun { |
| 128 | + logger.Printf("Would delete manifest link: %s@%s", repoName, dgst) |
| 129 | + return nil |
| 130 | + } |
| 131 | + |
| 132 | + logger.Printf("Deleting manifest link: %s@%s", repoName, dgst) |
| 133 | + if err := manifestService.Delete(ctx, dgst); err != nil { |
| 134 | + return fmt.Errorf("failed to delete the manifest link %s@%s: %v", repoName, dgst, err) |
| 135 | + } |
| 136 | + |
| 137 | + return nil |
| 138 | + }) |
| 139 | + if e, ok := err.(driver.PathNotFoundError); ok { |
| 140 | + logger.Printf("Skipped manifest link pruning for the repository %s: %v", repoName, e) |
| 141 | + } else if err != nil { |
| 142 | + return fmt.Errorf("failed to prune manifest links in the repository %s: %v", repoName, err) |
| 143 | + } |
| 144 | + |
| 145 | + return nil |
| 146 | + }) |
| 147 | + if e, ok := err.(driver.PathNotFoundError); ok { |
| 148 | + logger.Warnf("No repositories found: %v", e) |
| 149 | + return stats, nil |
| 150 | + } else if err != nil { |
| 151 | + return stats, err |
| 152 | + } |
| 153 | + |
| 154 | + vacuum := storage.NewVacuum(ctx, storageDriver) |
| 155 | + |
| 156 | + logger.Debugln("Removing repositories") |
| 157 | + for _, repoName := range reposToDelete { |
| 158 | + if dryRun { |
| 159 | + logger.Printf("Would delete repository: %s", repoName) |
| 160 | + continue |
| 161 | + } |
| 162 | + |
| 163 | + if err = vacuum.RemoveRepository(repoName); err != nil { |
| 164 | + return stats, fmt.Errorf("unable to remove the repository %s: %v", repoName, err) |
| 165 | + } |
| 166 | + } |
| 167 | + |
| 168 | + logger.Debugln("Processing blobs") |
| 169 | + blobStatter := registry.BlobStatter() |
| 170 | + err = registry.Blobs().Enumerate(ctx, func(dgst digest.Digest) error { |
| 171 | + if imageReference, ok := inuse[string(dgst)]; ok { |
| 172 | + logger.Debugf("Keeping the blob %s (it belongs to the image %s)", dgst, imageReference) |
| 173 | + return nil |
| 174 | + } |
| 175 | + |
| 176 | + desc, err := blobStatter.Stat(ctx, dgst) |
| 177 | + if err != nil { |
| 178 | + return err |
| 179 | + } |
| 180 | + |
| 181 | + stats.Blobs++ |
| 182 | + stats.DiskSpace += desc.Size |
| 183 | + |
| 184 | + if dryRun { |
| 185 | + logger.Printf("Would delete blob: %s", dgst) |
| 186 | + return nil |
| 187 | + } |
| 188 | + |
| 189 | + if err := vacuum.RemoveBlob(string(dgst)); err != nil { |
| 190 | + return fmt.Errorf("failed to delete the blob %s: %v", dgst, err) |
| 191 | + } |
| 192 | + |
| 193 | + return nil |
| 194 | + }) |
| 195 | + if e, ok := err.(driver.PathNotFoundError); ok { |
| 196 | + logger.Warnf("No repositories found: %v", e) |
| 197 | + return stats, nil |
| 198 | + } |
| 199 | + return stats, err |
| 200 | +} |
0 commit comments