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

Remove most ctr refs from CLI #874

Merged
merged 1 commit into from
Oct 31, 2023
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
3 changes: 1 addition & 2 deletions cmd/soci/commands/create.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ import (
"github.com/awslabs/soci-snapshotter/config"
"github.com/awslabs/soci-snapshotter/soci"
"github.com/awslabs/soci-snapshotter/soci/store"
"github.com/containerd/containerd/cmd/ctr/commands"
"github.com/urfave/cli"
)

Expand Down Expand Up @@ -61,7 +60,7 @@ var CreateCommand = cli.Command{
return errors.New("source image needs to be specified")
}

client, ctx, cancel, err := commands.NewClient(cliContext)
client, ctx, cancel, err := internal.NewClient(cliContext)
if err != nil {
return err
}
Expand Down
8 changes: 4 additions & 4 deletions cmd/soci/commands/image/rpull.go
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,9 @@ After pulling an image, it should be ready to use the same reference in a run
command.
`,
Flags: append(append(append(
commands.RegistryFlags,
commands.LabelFlag),
commands.SnapshotterFlags...),
internal.RegistryFlags,
internal.LabelFlag),
internal.SnapshotterFlags...),
cli.BoolFlag{
Name: skipContentVerifyOpt,
Usage: "Skip content verification for layers contained in this image.",
Expand All @@ -92,7 +92,7 @@ command.

config.indexDigest = context.String("soci-index-digest")

client, ctx, cancel, err := commands.NewClient(context)
client, ctx, cancel, err := internal.NewClient(context)
if err != nil {
return err
}
Expand Down
4 changes: 2 additions & 2 deletions cmd/soci/commands/index/list.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ import (
"text/tabwriter"
"time"

"github.com/awslabs/soci-snapshotter/cmd/soci/commands/internal"
"github.com/awslabs/soci-snapshotter/soci"
"github.com/containerd/containerd/cmd/ctr/commands"
"github.com/containerd/containerd/images"
"github.com/containerd/containerd/platforms"
specs "github.com/opencontainers/image-spec/specs-go/v1"
Expand Down Expand Up @@ -92,7 +92,7 @@ var listCommand = cli.Command{
plats = append(plats, pp)
}

client, ctx, cancel, err := commands.NewClient(cliContext)
client, ctx, cancel, err := internal.NewClient(cliContext)
if err != nil {
return err
}
Expand Down
4 changes: 2 additions & 2 deletions cmd/soci/commands/index/rm.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ import (
"context"
"fmt"

"github.com/awslabs/soci-snapshotter/cmd/soci/commands/internal"
"github.com/awslabs/soci-snapshotter/soci"
"github.com/awslabs/soci-snapshotter/soci/store"
"github.com/containerd/containerd/cmd/ctr/commands"
"github.com/opencontainers/go-digest"
"github.com/urfave/cli"
)
Expand Down Expand Up @@ -66,7 +66,7 @@ var rmCommand = cli.Command{
return err
}
} else {
client, ctx, cancel, err := commands.NewClient(cliContext)
client, ctx, cancel, err := internal.NewClient(cliContext)
if err != nil {
return err
}
Expand Down
84 changes: 84 additions & 0 deletions cmd/soci/commands/internal/client.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
/*
Copyright The Soci Snapshotter Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

/*
Copyright The containerd Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package internal

import (
gocontext "context"

"github.com/containerd/containerd"
"github.com/containerd/containerd/namespaces"
"github.com/containerd/containerd/pkg/epoch"
"github.com/containerd/log"
"github.com/urfave/cli"
)

// Largely taken from containerd/cmd/ctr/commands/client.go
sondavidb marked this conversation as resolved.
Show resolved Hide resolved

// AppContext returns the context for a command. Should only be called once per
// command, near the start.
//
// This will ensure the namespace is picked up and set the timeout, if one is
// defined.
func AppContext(context *cli.Context) (gocontext.Context, gocontext.CancelFunc) {
var (
ctx = gocontext.Background()
timeout = context.GlobalDuration("timeout")
namespace = context.GlobalString("namespace")
cancel gocontext.CancelFunc
)
ctx = namespaces.WithNamespace(ctx, namespace)
if timeout > 0 {
ctx, cancel = gocontext.WithTimeout(ctx, timeout)
} else {
ctx, cancel = gocontext.WithCancel(ctx)
}
if tm, err := epoch.SourceDateEpoch(); err != nil {
log.L.WithError(err).Warn("Failed to read SOURCE_DATE_EPOCH")
} else if tm != nil {
log.L.Debugf("Using SOURCE_DATE_EPOCH: %v", tm)
ctx = epoch.WithSourceDateEpoch(ctx, tm)
}
return ctx, cancel
}

// NewClient returns a new containerd client
func NewClient(context *cli.Context, opts ...containerd.ClientOpt) (*containerd.Client, gocontext.Context, gocontext.CancelFunc, error) {
timeoutOpt := containerd.WithTimeout(context.GlobalDuration("connect-timeout"))
opts = append(opts, timeoutOpt)
client, err := containerd.New(context.GlobalString("address"), opts...)
if err != nil {
return nil, nil, nil, err
}
ctx, cancel := AppContext(context)
return client, ctx, cancel, nil
}
42 changes: 42 additions & 0 deletions cmd/soci/commands/internal/label.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
/*
Copyright The Soci Snapshotter Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

/*
Copyright The containerd Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package internal

import (
"github.com/urfave/cli"
)

var LabelFlag = cli.StringSliceFlag{
Name: "label",
Usage: "Labels to attach to the image",
}
81 changes: 81 additions & 0 deletions cmd/soci/commands/internal/registry.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
/*
Copyright The Soci Snapshotter Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

/*
Copyright The containerd Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package internal

import (
"github.com/urfave/cli"
)

var RegistryFlags = []cli.Flag{
cli.BoolFlag{
Name: "skip-verify,k",
Usage: "Skip SSL certificate validation",
},
cli.BoolFlag{
Name: "plain-http",
Usage: "Allow connections using plain HTTP",
},
cli.StringFlag{
Name: "user,u",
Usage: "User[:password] Registry user and password",
},
cli.StringFlag{
Name: "refresh",
Usage: "Refresh token for authorization server",
},
cli.StringFlag{
Name: "hosts-dir",
// compatible with "/etc/docker/certs.d"
Usage: "Custom hosts configuration directory",
},
cli.StringFlag{
Name: "tlscacert",
Usage: "Path to TLS root CA",
},
cli.StringFlag{
Name: "tlscert",
Usage: "Path to TLS client certificate",
},
cli.StringFlag{
Name: "tlskey",
Usage: "Path to TLS client key",
},
cli.BoolFlag{
Name: "http-dump",
Usage: "Dump all HTTP request/responses when interacting with container registry",
},
cli.BoolFlag{
Name: "http-trace",
Usage: "Enable HTTP tracing for registry interactions",
},
}
45 changes: 45 additions & 0 deletions cmd/soci/commands/internal/snapshotter.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
/*
Copyright The Soci Snapshotter Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

/*
Copyright The containerd Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package internal

import (
"github.com/urfave/cli"
)

var SnapshotterFlags = []cli.Flag{
cli.StringFlag{
Name: "snapshotter",
Usage: "Snapshotter name. Empty value stands for the default value.",
EnvVar: "CONTAINERD_SNAPSHOTTER",
},
}
10 changes: 4 additions & 6 deletions cmd/soci/commands/push.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ import (
"github.com/awslabs/soci-snapshotter/fs"
"github.com/awslabs/soci-snapshotter/soci"
"github.com/awslabs/soci-snapshotter/soci/store"
"github.com/containerd/containerd/cmd/ctr/commands"
"github.com/containerd/containerd/reference"
dockercliconfig "github.com/docker/cli/cli/config"
ocispec "github.com/opencontainers/image-spec/specs-go/v1"
Expand All @@ -50,10 +49,9 @@ If multiple soci indices exist for the given image, the most recent one will be
After pushing the soci artifacts, they should be available in the registry. Soci artifacts will be pushed only
if they are available in the snapshotter's local content store.
`,
Flags: append(append(append(append(
commands.RegistryFlags,
commands.LabelFlag),
commands.SnapshotterFlags...),
Flags: append(append(append(
internal.RegistryFlags,
internal.SnapshotterFlags...),
internal.PlatformFlags...),
internal.ExistingIndexFlag,
cli.Uint64Flag{
Expand All @@ -73,7 +71,7 @@ if they are available in the snapshotter's local content store.
return fmt.Errorf("please provide an image reference to push")
}

client, ctx, cancel, err := commands.NewClient(cliContext)
client, ctx, cancel, err := internal.NewClient(cliContext)
if err != nil {
return err
}
Expand Down
4 changes: 2 additions & 2 deletions cmd/soci/commands/rebuild_db.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,17 @@ package commands
import (
"path/filepath"

"github.com/awslabs/soci-snapshotter/cmd/soci/commands/internal"
"github.com/awslabs/soci-snapshotter/soci"
"github.com/awslabs/soci-snapshotter/soci/store"
"github.com/containerd/containerd/cmd/ctr/commands"
"github.com/urfave/cli"
)

var RebuildDBCommand = cli.Command{
Name: "rebuild-db",
Usage: `rebuild the artifacts database. You should use this command after "rpull" so that indices/ztocs can be discovered by commands like "soci index list", and after "index rm" when using the containerd content store so that deleted orphaned zTOCs will be forgotten`,
Action: func(cliContext *cli.Context) error {
client, ctx, cancel, err := commands.NewClient(cliContext)
client, ctx, cancel, err := internal.NewClient(cliContext)
if err != nil {
return err
}
Expand Down
Loading