deprecate estargz

google · Apr 18, 2023 · 330b78f · 330b78f
1 parent 1cb7e13
commit 330b78f
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 164 deletions.
diff --git a/README.md b/README.md
@@ -36,7 +36,7 @@ Over time, we will add new functionality under experimental environment variable
 
 | Env Var | Value(s) | What is does |
 |---------|----------|--------------|
-| `GGCR_EXPERIMENT_ESTARGZ` | `"1"` | When enabled this experiment will direct `tarball.LayerFromOpener` to emit [estargz](https://github.com/opencontainers/image-spec/issues/815) compatible layers, which enable them to be lazily loaded by an appropriately configured containerd. |
+| `GGCR_EXPERIMENT_ESTARGZ` | `"1"` | ⚠️DEPRECATED⚠️: When enabled this experiment will direct `tarball.LayerFromOpener` to emit [estargz](https://github.com/opencontainers/image-spec/issues/815) compatible layers, which enable them to be lazily loaded by an appropriately configured containerd. |
 
 
 ### `v1.Image`

diff --git a/internal/estargz/estargz.go b/internal/estargz/estargz.go
diff --git a/internal/estargz/estargz_test.go b/internal/estargz/estargz_test.go
diff --git a/pkg/v1/tarball/layer.go b/pkg/v1/tarball/layer.go
@@ -25,7 +25,6 @@ import (
 	"github.com/containerd/stargz-snapshotter/estargz"
 	"github.com/google/go-containerregistry/internal/and"
 	comp "github.com/google/go-containerregistry/internal/compression"
-	gestargz "github.com/google/go-containerregistry/internal/estargz"
 	ggzip "github.com/google/go-containerregistry/internal/gzip"
 	"github.com/google/go-containerregistry/internal/zstd"
 	"github.com/google/go-containerregistry/pkg/compression"
@@ -160,13 +159,17 @@ func WithCompressedCaching(l *layer) {
 // WithEstargzOptions is a functional option that allow the caller to pass
 // through estargz.Options to the underlying compression layer.  This is
 // only meaningful when estargz is enabled.
+//
+// Deprecated: WithEstargz is deprecated, and will be removed in a future release.
 func WithEstargzOptions(opts ...estargz.Option) LayerOption {
 	return func(l *layer) {
 		l.estgzopts = opts
 	}
 }
 
 // WithEstargz is a functional option that explicitly enables estargz support.
+//
+// Deprecated: WithEstargz is deprecated, and will be removed in a future release.
 func WithEstargz(l *layer) {
 	oguncompressed := l.uncompressedopener
 	estargz := func() (io.ReadCloser, error) {
@@ -238,6 +241,7 @@ func LayerFromOpener(opener Opener, opts ...LayerOption) (v1.Layer, error) {
 	}
 
 	if estgz := os.Getenv("GGCR_EXPERIMENT_ESTARGZ"); estgz == "1" {
+		logs.Warn.Println("GGCR_EXPERIMENT_ESTARGZ is deprecated, and will be removed in a future release.")
 		opts = append([]LayerOption{WithEstargz}, opts...)
 	}