Skip to content

Commit

Permalink
Add -prune option to dockerregistry
Browse files Browse the repository at this point in the history
Signed-off-by: Oleg Bulatov <[email protected]>
  • Loading branch information
Oleg Bulatov committed Jun 14, 2017
1 parent 322171b commit c930106
Show file tree
Hide file tree
Showing 3 changed files with 230 additions and 4 deletions.
65 changes: 62 additions & 3 deletions pkg/cmd/dockerregistry/dockerregistry.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@ package dockerregistry
import (
"crypto/tls"
"crypto/x509"
"flag"
"fmt"
"io"
"io/ioutil"
"net/http"
"os"
"strings"
"time"

log "github.com/Sirupsen/logrus"
Expand All @@ -19,8 +21,10 @@ import (
"github.com/docker/distribution/health"
"github.com/docker/distribution/registry/auth"
"github.com/docker/distribution/registry/handlers"
"github.com/docker/distribution/registry/storage"
"github.com/docker/distribution/registry/storage/driver/factory"
"github.com/docker/distribution/uuid"
"github.com/docker/distribution/version"
distversion "github.com/docker/distribution/version"

_ "github.com/docker/distribution/registry/auth/htpasswd"
_ "github.com/docker/distribution/registry/auth/token"
Expand All @@ -35,18 +39,73 @@ import (
_ "github.com/docker/distribution/registry/storage/driver/s3-aws"
_ "github.com/docker/distribution/registry/storage/driver/swift"

"strings"
kubeversion "k8s.io/kubernetes/pkg/version"

"github.com/openshift/origin/pkg/cmd/server/crypto"
"github.com/openshift/origin/pkg/cmd/util/clientcmd"
"github.com/openshift/origin/pkg/dockerregistry/server"
"github.com/openshift/origin/pkg/dockerregistry/server/api"
"github.com/openshift/origin/pkg/dockerregistry/server/audit"
registryconfig "github.com/openshift/origin/pkg/dockerregistry/server/configuration"
"github.com/openshift/origin/pkg/version"
)

var prune = flag.Bool("prune", false, "prune blobs from the storage and exit")

func versionFields() log.Fields {
return log.Fields{
"distribution_version": distversion.Version,
"kubernetes_version": kubeversion.Get(),
"openshift_version": version.Get(),
}
}

// ExecutePruner runs the pruner.
func ExecutePruner(configFile io.Reader) {
log.WithFields(versionFields()).Info("start prune")

config, _, err := registryconfig.Parse(configFile)
if err != nil {
log.Fatalf("error parsing configuration file: %s", err)
}

// A lot of installations have the 'debug' log level in their config files,
// but it's too verbose for pruning. Therefore we ignore it, but we still
// respect overrides using environment variables.
config.Loglevel = ""
config.Log.Level = configuration.Loglevel(os.Getenv("REGISTRY_LOG_LEVEL"))
if config.Log.Level == "" {
config.Log.Level = "info"
}

ctx := context.Background()
ctx, err = configureLogging(ctx, config)
if err != nil {
log.Fatalf("error configuring logging: %s", err)
}

registryClient := server.NewRegistryClient(clientcmd.NewConfig().BindToFile())

storageDriver, err := factory.Create(config.Storage.Type(), config.Storage.Parameters())
if err != nil {
log.Fatalf("error creating storage driver: %s", err)
}

registry, err := storage.NewRegistry(ctx, storageDriver, storage.EnableDelete)
if err != nil {
log.Fatalf("error creating registry: %s", err)
}

server.Prune(ctx, storageDriver, registry, registryClient)
}

// Execute runs the Docker registry.
func Execute(configFile io.Reader) {
if *prune {
ExecutePruner(configFile)
return
}

dockerConfig, extraConfig, err := registryconfig.Parse(configFile)
if err != nil {
log.Fatalf("error parsing configuration file: %s", err)
Expand All @@ -64,7 +123,7 @@ func Execute(configFile io.Reader) {
registryClient := server.NewRegistryClient(clientcmd.NewConfig().BindToFile())
ctx = server.WithRegistryClient(ctx, registryClient)

log.Infof("version=%s", version.Version)
log.WithFields(versionFields()).Info("start registry")
// inject a logger into the uuid library. warns us if there is a problem
// with uuid generation under low entropy.
uuid.Loggerf = context.GetLogger(ctx).Warnf
Expand Down
3 changes: 2 additions & 1 deletion pkg/dockerregistry/server/errorblobstore.go
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,8 @@ func (f statCrossMountCreateOptions) Apply(v interface{}) error {
if err != nil {
context.GetLogger(f.ctx).Infof("cannot mount blob %s from repository %s: %v - disabling cross-repo mount",
opts.Mount.From.Digest().String(),
opts.Mount.From.Name())
opts.Mount.From.Name(),
err)
opts.Mount.ShouldMount = false
return nil
}
Expand Down
166 changes: 166 additions & 0 deletions pkg/dockerregistry/server/prune.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
package server

import (
"fmt"

"github.com/docker/distribution"
"github.com/docker/distribution/context"
"github.com/docker/distribution/digest"
"github.com/docker/distribution/manifest/schema2"
"github.com/docker/distribution/reference"
"github.com/docker/distribution/registry/storage"
"github.com/docker/distribution/registry/storage/driver"

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

imageapi "github.com/openshift/origin/pkg/image/api"
)

func imageStreamHasManifestDigest(is *imageapi.ImageStream, dgst digest.Digest) bool {
for _, tagEventList := range is.Status.Tags {
for _, tagEvent := range tagEventList.Items {
if tagEvent.Image == string(dgst) {
return true
}
}
}
return false
}

// Prune removes blobs which are not used by Images in OpenShift.
//
// TODO(dmage): remove layer links to a blob if the blob is removed or it doesn't belong to the ImageStream.
// TODO(dmage): keep young blobs (docker/distribution#2297).
func Prune(ctx context.Context, storageDriver driver.StorageDriver, registry distribution.Namespace, registryClient RegistryClient) {
logger := context.GetLogger(ctx)

repositoryEnumerator, ok := registry.(distribution.RepositoryEnumerator)
if !ok {
logger.Fatal("unable to convert Namespace to RepositoryEnumerator")
}

oc, _, err := registryClient.Clients()
if err != nil {
logger.Fatalf("error getting clients: %s", err)
}

imageList, err := oc.Images().List(metav1.ListOptions{})
if err != nil {
logger.Fatalf("error listing images: %s", err)
}

inuse := make(map[string]string)
for _, image := range imageList.Items {
// Keep the manifest.
inuse[image.Name] = image.DockerImageReference

// Keep the config for a schema 2 manifest.
if image.DockerImageManifestMediaType == schema2.MediaTypeManifest {
inuse[image.DockerImageMetadata.ID] = image.DockerImageReference
}

// Keep image layers.
for _, layer := range image.DockerImageLayers {
inuse[layer.Name] = image.DockerImageReference
}
}

var reposToDelete []string
err = repositoryEnumerator.Enumerate(ctx, func(repoName string) error {
logger.Debugln("Processing repository", repoName)

named, err := reference.WithName(repoName)
if err != nil {
return fmt.Errorf("failed to parse the repo name %s: %v", repoName, err)
}

ref, err := imageapi.ParseDockerImageReference(repoName)
if err != nil {
return fmt.Errorf("failed to parse the image reference %s: %v", repoName, err)
}

is, err := oc.ImageStreams(ref.Namespace).Get(ref.Name, metav1.GetOptions{})
if kerrors.IsNotFound(err) {
logger.Printf("The image stream %s/%s is not found, will remove the whole repository", ref.Namespace, ref.Name)

// We cannot delete the repository at this point, because it would break Enumerate.
reposToDelete = append(reposToDelete, repoName)

return nil
} else if err != nil {
return fmt.Errorf("failed to get the image stream %s: %v", repoName, err)
}

repository, err := registry.Repository(ctx, named)
if err != nil {
return err
}

manifestService, err := repository.Manifests(ctx)
if err != nil {
return err
}

manifestEnumerator, ok := manifestService.(distribution.ManifestEnumerator)
if !ok {
return fmt.Errorf("unable to convert ManifestService into ManifestEnumerator")
}

err = manifestEnumerator.Enumerate(ctx, func(dgst digest.Digest) error {
if imageReference, ok := inuse[string(dgst)]; ok && imageStreamHasManifestDigest(is, dgst) {
logger.Debugf("Keeping the manifest %s@%s (it belongs to the image %s)", repoName, dgst, imageReference)
return nil
}

logger.Printf("Deleting the manifest: %s@%s", repoName, dgst)
err = manifestService.Delete(ctx, dgst)
if err != nil {
return fmt.Errorf("failed to delete the manifest %s: %s", dgst, err)
}

return nil
})
if e, ok := err.(driver.PathNotFoundError); ok {
logger.Printf("Skipped manifests pruning for the repository %s: %s", repoName, e)
} else if err != nil {
return fmt.Errorf("failed to prune manifests in the repository %s: %s", repoName, err)
}

return nil
})
if e, ok := err.(driver.PathNotFoundError); ok {
logger.Warnf("No repositories are found: %s", e)
return
} else if err != nil {
logger.Fatal(err)
}

vacuum := storage.NewVacuum(ctx, storageDriver)

logger.Debugln("Removing repositories")
for _, repoName := range reposToDelete {
err = vacuum.RemoveRepository(repoName)
if err != nil {
logger.Fatal("Failed to remove the repository %s: %v", repoName, err)
}
}

logger.Debugln("Processing blobs")
err = registry.Blobs().Enumerate(ctx, func(dgst digest.Digest) error {
if imageReference, ok := inuse[string(dgst)]; ok {
logger.Debugf("Keeping the blob %s (it belongs to the image %s)", dgst, imageReference)
return nil
}

err := vacuum.RemoveBlob(string(dgst))
if err != nil {
return fmt.Errorf("failed to delete the blob %s: %s", dgst, err)
}

return nil
})
if err != nil {
logger.Fatal(err)
}
}

0 comments on commit c930106

Please sign in to comment.